RESTful

使用 IMI 提供的路由请求方法判断，可以实现 RESTful 风格的 api 开发。

RESTful 风格控制器示例 (query/find/create/update/delete)：

  1. <?php
  2. namespace ImiDemo\HttpDemo\MainServer\Controller;
  4. use Imi\Controller\HttpController;
  5. use Imi\Server\View\Annotation\View;
  6. use Imi\Server\Route\Annotation\Route;
  7. use Imi\Server\Route\Annotation\Action;
  8. use Imi\Server\Route\Annotation\Controller;
  10. /**
  11.  * @Controller(prefix="/Rest/")
  12.  * @View(renderType="json")
  13.  */
  14. class Rest extends HttpController
  15. {
  16.     /**
  17.      * query
  18.      * 
  19.      * @Action
  20.      * @Route(url="", method={"GET"})
  21.      * @return void
  22.      */
  23.     public function query()
  24.     {
  25.         return [1, 2, 3];
  26.     }
  28.     /**
  29.      * find
  30.      * 
  31.      * @Action
  32.      * @Route(url="{id}", method={"GET"})
  33.      * 
  34.      * @param int $id
  35.      * @return void
  36.      */
  37.     public function find($id)
  38.     {
  39.         return [
  40.             'id'    =>    $id,
  41.         ];
  42.     }
  44.     /**
  45.      * create
  46.      * 
  47.      * @Action
  48.      * @Route(url="", method={"POST"})
  49.      * @return void
  50.      */
  51.     public function create()
  52.     {
  53.         return [
  54.             'operation'    =>    'create',
  55.             'postData'    =>    $this->request->getParsedBody(),
  56.             'success'    =>    true,
  57.         ];
  58.     }
  60.     /**
  61.      * update
  62.      * 
  63.      * @Action
  64.      * @Route(url="{id}", method={"PUT"})
  65.      * 
  66.      * @param int $id
  67.      * @return void
  68.      */
  69.     public function update($id)
  70.     {
  71.         return [
  72.             'id'        =>    $id,
  73.             'operation'    =>    'update',
  74.             'success'    =>    true,
  75.         ];
  76.     }
  78.     /**
  79.      * delete
  80.      * 
  81.      * @Action
  82.      * @Route(url="{id}", method={"DELETE"})
  83.      * 
  84.      * @param int $id
  85.      * @return void
  86.      */
  87.     public function delete($id)
  88.     {
  89.         return [
  90.             'id'        =>    $id,
  91.             'operation'    =>    'delete',
  92.             'success'    =>    true,
  93.         ];
  94.     }
  95. }