PHP编写RESTful接口的方法

2024-04-10 17:12:53

这是一个轻量级框架，专为快速开发RESTful接口而设计。如果你和我一样，厌倦了使用传统的MVC框架编写微服务或者前后端分离的API接口，受不了为了一个简单接口而做的很多多余的coding（和CTRL-C/CTRL-V），那么，你肯定会喜欢这个框架！

先举个栗子
1、写个HelloWorld.php，放到框架指定的目录下（默认是和index.php同级的apis/目录）

/**
 * @path("/hw")
 */
class HelloWorld
{
  /**
   * @route({"GET","/"})
   */
  public function doSomething() {
    return "Hello World!";
  }
}

2、浏览器输入http://your-domain/hw/
你将看到：Hello World!就是这么简单，不需要额外配置，不需要继承也不需要组合。
发生了什么
回过头看HelloWorld.php，特殊的地方在于注释（@path，@route），没错，框架通过注释获取路由信息和绑定输入输出。但不要担心性能，注释只会在类文件修改后解析一次。更多的@注释后面会说明。

再看个更具体的例子
这是一个登录接口的例子

/**
 * 用户权限验证
 * @path("/tokens/")
 */
class Tokens
{
  /**
   * 登录
   * 通过用户名密码授权
   * @route({"POST","/accounts/"})
   * @param({"account", "$._POST.account"}) 账号
   * @param({"password", "$._POST.password"}) 密码
   *
   * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用户名或密码无效
   *
   * @return({"body"})
   * 返回token，同cookie中的token相同,
   * {"token":"xxx", "uid" = "xxx"}
   *
   * @return({"cookie","token","$token","+365 days","/"}) 通过cookie返回token
   * @return({"cookie","uid","$uid","+365 days","/"}) 通过cookie返回uid
   */
  public function createTokenByAccounts($account, $password, &$token,&$uid){
    //验证用户
    $uid = $this->users->verifyPassword($account, $password);
    Verify::isTrue($uid, new InvalidPassword($account));
    $token = ...;
    return ['token'=>$token, 'uid'=>$uid];
  }
  /**
   * @property({"default":"@Users"})  依赖的属性，由框架注入
   * @var Users
   */
  public $users;
}

还能做什么

依赖管理（依赖注入），
自动输出接口文档（不是doxgen式的类、方法文档，而是描述http接口的文档）
接口缓存
hook

配合ezsql访问数据库
ezsql是一款简单的面向对象的sql构建工具，提供简单的基本sql操作。
接口

/** @path(/myclass) */
class MyClass{

  /**
  * @route({"GET","/do"})
  * @param({"arg0","$._GET.arg0"})
  */
  public doSomething($arg0){
    return Sql::select('xxx')->from('table_xxx')->where( 'xxx = ?', $arg0)->get($this->db);
  }
  /**
   * 依赖注入PDO实例
   * @property
   * @var PDO
   */
  public $db;
}

配置文件

{
  {
    "MyClass":{
      "properties":{
        "db":"@db1"
      }
    },
  },
  "db1":{
    "singleton":true,
    "class":"PDO",
    "pass_by_construct":true,
    "properties":{
      "dsn":"mysql:host=127.0.0.1;dbname=xxx",
      "username":"xxxx",
      "passwd":"xxxx"
    }
  },
}

以上就是本文的全部内容，希望对大家的学习有所帮助。

PHP编写RESTful接口

首先我们来认识下RESTful Restful是一种设计风格而不是标准,比如一个接口原本是这样的: http://www.test.com/user/view/id/1 表示获取id为1的用户信息,如果使用Restful风格,可以变成这样: http://www.test.com/user/1 可以很明显的看出这样做的好处: 1.更简洁的URL,对程序员友好 2.不暴露内部代码结构,更安全那么,如何实现这个接口呢?首先,我们需要接收到/user/1部分. $path = $_SERVER['P
PHP实现自动识别Restful API的返回内容类型

如题,PHP如何自动识别第三方Restful API的内容,自动渲染成 json.xml.html.serialize.csv.php等数据? 其实这也不难,因为Rest API也是基于http协议的,只要我们按照协议走,就能做到自动化识别 API 的内容,方法如下: 1.API服务端要返回明确的 http Content-Type头信息,如: Content-Type: application/json; charset=utf-8 Content-Type: application/xml;
php处理restful请求的路由类分享

复制代码代码如下: <?php class Router { // 路由表 private $routers = array( array("name"=>"userlist", "pattern"=>"get /user", "action"=>"User#get"), array(
php基于curl扩展制作跨平台的restfule 接口

restfule 接口适用的平台:跨平台所依赖:curl扩展 git:https://git.oschina.net/anziguoer/restAPI ApiServer.php <?php /** * @Author: yangyulong * @Email : anziguoer@sina.com * @Date: 2015-04-30 05:38:34 * @Last Modified by: yangyulong * @Last Modified time: 2015-04-30
PHP编写RESTful接口的方法

这是一个轻量级框架,专为快速开发RESTful接口而设计.如果你和我一样,厌倦了使用传统的MVC框架编写微服务或者前后端分离的API接口,受不了为了一个简单接口而做的很多多余的coding(和CTRL-C/CTRL-V),那么,你肯定会喜欢这个框架! 先举个栗子 1.写个HelloWorld.php,放到框架指定的目录下(默认是和index.php同级的apis/目录) /** * @path("/hw") */ class HelloWorld { /** * @route({&qu
基于Restful接口调用方法总结(超详细)

由于在实际项目中碰到的restful服务,参数都以json为准.这里我获取的接口和传入的参数都是json字符串类型.发布restful服务可参照文章 Jersey实现Restful服务(实例讲解),以下接口调用基于此服务. 基于发布的Restful服务,下面总结几种常用的调用方法. (1)Jersey API package com.restful.client; import com.fasterxml.jackson.core.JsonProcessingException; import
Python编写登陆接口的方法

本文实例为大家分享了Python编写登陆接口的具体代码,供大家参考,具体内容如下 1.输入用户名密码: 2.认证成功后显示欢迎信息: 3.错误三次后,账号被锁定. 账号文件:user.txt 锁定文件:locked.txt 流程图如下: # -*- coding:utf-8 -*- # Author Caoxl import sys account_file='E:\user.txt' locked_file='E:\locked.txt' def deny_account(username):
用Node编写RESTful API接口的示例代码

前言本文介绍了如何用Node开发web程序,并通过一个todo list练习来介绍如何创建符合RESTful风格的API接口. 创建HTTP服务器用Node创建HTTP服务器是非常方便的. 创建HTTP服务器要调用http.createServer()函数,它只有一个参数,是个回调函数,服务器每次收到HTTP请求后都会调用这个回调函数.这个回调会收到两个参数,请求和响应对象,通常简写为req和res: var http = require('http') var server = http.
Ajax调用restful接口传送Json格式数据的方法

ajax传送json格式数据,关键是指定contentType,data要是json格式如果是restful接口,把type改成对应的post(增).delete(删).put(改).get(查)即可 var post_data={"name":"test001","pass":"xxxx"}; $.ajax({ url: "http://192.168.10.111:8080/uc/login", ty
python用post访问restful服务接口的方法

具体代码如下: import requests import json data={"ids": ["00007190","00007191"]} url="http://XXXXX" data_json = json.dumps(data) headers = {'Content-type': 'application/json'} response = requests.post(url, data=data_json,
python3使用flask编写注册post接口的方法

使用python3的Flask库写了一个接口,封装了很多东西,仅供参考即可! 代码如下: #!/usr/bin/python3 # -*- coding: utf-8 -*- import re from flask import request from flask_restful import Resource import aes_utils import mysql_utils import sqls_user class Register(Resource): """
java调用Restful接口的三种方法

目录 1,基本介绍 2,HttpURLConnection实现 3.HttpClient实现 4.Spring的RestTemplate 1,基本介绍 Restful接口的调用,前端一般使用ajax调用,后端可以使用的方法比较多, 本次介绍三种: 1.HttpURLConnection实现 2.HttpClient实现 3.Spring的RestTemplate 2,HttpURLConnection实现 @Controller public class RestfulAction { @Aut
Spring Boot中使用Swagger3.0.0版本构建RESTful APIs的方法

目录一.项目描述二.简介三.Swagger2.X和Swagger3.0.0 的对比 1)SpringFox 2.x 发布 2)SpringFox 3.0.0 发布 3)swagger3.0 与2.xx配置差异: 四.注解说明 @Api @ApiOperation @ApiImplicitParams @ApiImplicitParam @ApiResponses @ApiModel @ApiModelProperty @ApiIgnore 五.案例准备工作 0.项目目录 1.pom依赖 2

PHP编写RESTful接口的方法

相关推荐

随机推荐