PHP编写RESTful接口的方法

 更新时间:2016年02月21日 15:36:57   投稿:lijiao  
这篇文章主要为大家详细介绍了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"      
    }
  },
}

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

相关文章

  • Yii rules常用规则示例

    Yii rules常用规则示例

    这篇文章主要介绍了Yii rules常用规则,结合实例形式分析了rules规则的功能,定义及具体使用方法,需要的朋友可以参考下
    2016-03-03
  • ThinkPHP自动完成中使用函数与回调方法实例

    ThinkPHP自动完成中使用函数与回调方法实例

    这篇文章主要介绍了ThinkPHP自动完成中使用函数与回调方法,实例分析了ThinkPHP中自动填充的用法以及使用函数与回调的方法,是非常实用的技巧,需要的朋友可以参考下
    2014-11-11
  • 腾讯QQ微博API接口获取微博内容

    腾讯QQ微博API接口获取微博内容

    腾讯QQ微博API接口获取微博内容的实例。
    2013-10-10
  • php发送get、post请求的6种方法简明总结

    php发送get、post请求的6种方法简明总结

    这篇文章主要介绍了php发送get、post请求的6种方法简明总结,分别为使用file_get_contents 、fopen、fsockopen、curl来发送GET和POST请求,需要的朋友可以参考下
    2014-07-07
  • twig模板获取全局变量的方法

    twig模板获取全局变量的方法

    这篇文章主要介绍了twig模板获取全局变量的方法,结合实例形式分析了twig模板操作变量的常用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2016-02-02
  • 浅谈PHP中关于foreach使用引用变量的坑

    浅谈PHP中关于foreach使用引用变量的坑

    下面小编就为大家带来一篇PHP不使用递归的无限级分类的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-11-11
  • PHP引用(&)各种使用方法实例详解

    PHP引用(&)各种使用方法实例详解

    php的引用(就是在变量或者函数、对象等前面加上&符号),在PHP 中引用的意思是:不同的名字访问同一个变量内容。与C语言中的指针是有差别的.C语言中的指针里面存储的是变量的内容,在内存中存放的地址
    2014-03-03
  • yii2中的rules 自定义验证规则详解

    yii2中的rules 自定义验证规则详解

    yii2的一个强大之处之一就是他的Form组件,既方便又安全。本文给大家介绍yii2中的rules 自定义验证规则,需要的朋友参考下
    2016-04-04
  • swoole锁的机制代码实例讲解

    swoole锁的机制代码实例讲解

    这篇文章主要介绍了swoole锁的机制代码实例讲解,对于锁的介绍讲解的很清晰,有感兴趣的同学可以学习下
    2021-03-03
  • php微信公众平台开发(四)回复功能开发

    php微信公众平台开发(四)回复功能开发

    这篇文章主要介绍了php微信公众平台开发的第四篇,微信回复功能开发,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12

最新评论