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 Framework框架获取分类下面的所有子类方法

    Yii Framework框架获取分类下面的所有子类方法

    Yii是一个基于组件、用于开发大型 Web 应用的 高性能 PHP 框架。Yii 几乎拥有了 所有的特性 ,包括 MVC、DAO/ActiveRecord、I18N/L10N、caching、基于 JQuery 的 AJAX 支持、用户认证和基于角色的访问控制、脚手架、输入验证、部件、事件、主题化以及 Web 服务等等。
    2014-06-06
  • 避免Smarty与CSS语法冲突的方法

    避免Smarty与CSS语法冲突的方法

    这篇文章主要介绍了避免Smarty与CSS语法冲突的方法,实例分析了Smarty与CSS中大括号{}冲突的处理技巧,需要的朋友可以参考下
    2015-03-03
  • php设计模式之正面模式实例分析【星际争霸游戏案例】

    php设计模式之正面模式实例分析【星际争霸游戏案例】

    这篇文章主要介绍了php设计模式之正面模式,结合星际争霸游戏案例形式分析了php正面模式相关原理、使用技巧与操作注意事项,需要的朋友可以参考下
    2020-03-03
  • YII CLinkPager分页类扩展增加显示共多少页

    YII CLinkPager分页类扩展增加显示共多少页

    yii的分页类CLinkPager默认是不支持显示共x页的,那么现在接的项目有这样的需求,怎么办呢?下面通过本文给大家介绍YII CLinkPager分页类扩展增加显示共多少页的实例代码,需要的朋友参考下吧
    2016-01-01
  • laravel实现查询最后执行的一条sql语句的方法

    laravel实现查询最后执行的一条sql语句的方法

    今天小编就为大家分享一篇laravel实现查询最后执行的一条sql语句的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-10-10
  • IP138 IP地址查询小偷实现代码

    IP138 IP地址查询小偷实现代码

    下面的代码是获取ip138的数据,并显示。
    2010-02-02
  • PHP7.0版本备注

    PHP7.0版本备注

    这篇文章主要介绍了PHP7.0版本备注,新版本发布在性能方面大大提升,同时在语言特性方面也改变了不少,以下内容是LCT翻译对官方版本升级备注,需要的朋友可以参考下
    2015-07-07
  • 使用淘宝IP库获取用户ip地理位置

    使用淘宝IP库获取用户ip地理位置

    以前用过GOOGLE地图和百度地图获取过用户地理位置,现在又多了一个方法,那就是使用淘宝IP库获取用户ip地理位置,一起来看代码吧。
    2013-10-10
  • Laravel 5框架学习之环境与配置

    Laravel 5框架学习之环境与配置

    本文给大家主要介绍的是Laravel5框架中的环境配置,给大家详细介绍了.env的配置文件,包含的数据库配置信息的详细解释,这里推荐给大家,有需要的小伙伴参考下。
    2015-04-04
  • PHP+MySql实现一个简单的留言板

    PHP+MySql实现一个简单的留言板

    留言板是接触WEB开发的基础,写一个留言板需要知道前端的一些基础标签,对数据库有一个了解会基础SQL语言,PHP基础知识,前段基础+数据库基础+PHP基础=>留言板
    2020-07-07

最新评论