欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

PHP编写RESTful接口的方法

程序员文章站 2024-04-01 18:33:46
这是一个轻量级框架,专为快速开发restful接口而设计。如果你和我一样,厌倦了使用传统的mvc框架编写微服务或者前后端分离的api接口,受不了为了一个简单接口而做的很多多...

这是一个轻量级框架,专为快速开发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、浏览器输入
你将看到: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"      
    }
  },
}

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