Home  >  Article  >  Backend Development  >  Method of writing RESTful interface in PHP, writing restful_PHP tutorial in PHP

Method of writing RESTful interface in PHP, writing restful_PHP tutorial in PHP

WBOY
WBOYOriginal
2016-07-12 08:58:45806browse

How to write RESTful interfaces in PHP, write restful in php

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 me give you 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!";
  }
}

2. Enter http://your-domain/hw/
into the browser
You will see: Hello World! It’s 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.

Let’s look at a more specific example
This is an example of the 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 ['token'=>$token, 'uid'=>$uid];
  } 
  /**
   * @property({"default":"@Users"})  依赖的属性,由框架注入
   * @var Users
   */
  public $users;
}

What else can you do

  • Dependency management (dependency injection),
  • Automatically output interface documents (not doxgen-style class and method documents, but documents describing http interfaces)
  • Interface cache
  • hook

Cooperate with ezsql to access the 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('xxx')->from('table_xxx')->where( 'xxx = ?', $arg0)->get($this->db);
  }
  /**
   * 依赖注入PDO实例
   * @property
   * @var PDO
   */
  public $db;
}

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

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

Articles you may be interested in:

  • Sharing of routing classes for PHP to handle restful requests
  • PHP implements automatic recognition of the return content type of Restful API
  • php Create a cross-platform restfule interface based on curl extension

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/1101653.htmlTechArticleHow to write RESTful interfaces in PHP, write restful in php This is a lightweight framework designed for rapid development of RESTful interfaces And design. If you are like me, tired of using the traditional MVC framework...
Statement:
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn