How to write RESTful interface in PHP-PHP Tutorial-php.cn

How to write RESTful interface in PHP

高洛峰

Release： 2023-03-04 15:36:02

Original

2032 people have browsed it

This is a lightweight framework designed for rapid development of RESTful interfaces. If you are like me and are tired of using the traditional MVC framework to write microservices or API interfaces with separate front-end and back-end, and can't stand a lot of redundant coding (and CTRL-C/CTRL-V) for a simple interface, then, You will definitely love this frame!

Let’s give a chestnut first
1. Write HelloWorld.php and put it in the directory specified by the framework (the default is the apis/directory at the same level as index.php)

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

Copy after login

2 , enter http://your-domain/hw/
in the browser and you will see: Hello World! It is that simple, no additional configuration, no inheritance or combination is required.
What happened
Looking back at HelloWorld.php, the special thing is the annotations (@path, @route). Yes, the framework obtains routing information and binds input and output through annotations. But don't worry about performance, annotations will only be parsed once after the class file is modified. More @ comments will be explained later.

Look at a more specific example
This is an example of a login interface

/**
 * 用户权限验证
 * @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 [&#39;token&#39;=>$token, &#39;uid&#39;=>$uid];
  } 
  /**
   * @property({"default":"@Users"})  依赖的属性，由框架注入
   * @var Users
   */
  public $users;
}

Copy after login

What else can be done

Dependency management (dependency injection),

Automatically output interface documents (not doxgen-style class and method documents, but documents describing the http interface)

Interface cache

hook

Cooperation ezsql access database
ezsql is a simple object-oriented sql building tool that provides simple basic sql operations.
Interface

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

Copy after login

Configuration file

{
  {
    "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"     
    }
  },
}

Copy after login

The above is the entire content of this article, I hope it will be helpful to everyone's study.

For more articles related to methods of writing RESTful interfaces in PHP, please pay attention to the PHP Chinese website!