本文的主要目地是为大家详细介绍了PHP怎么样编写RESTful接口的方法,详细介绍了怎样使用PHP编写RESTful接口的例子,有兴趣的参考一下吧。
这是一个轻量级的框架,专门为快速开发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"
}
},
}