restful.md

RESTFUL

Return

reference yii2

• GET /users: 逐页列出所有用户；
• HEAD /users: 显示用户列表的概要信息；
• POST /users: 创建一个新用户；
• GET /users/123: 返回用户为123的详细信息;
• HEAD /users/123: 显示用户 123 的概述信息;
• PATCH /users/123 and PUT /users/123: 更新用户123;
• DELETE /users/123: 删除用户123;
• OPTIONS /users: 显示关于末端 /users 支持的动词;
• OPTIONS /users/123: 显示有关末端 /users/123 支持的动词。

controller

default RESTFul action name equals to REQUEST_METHOD

if use controller layer. the controller class is must be extends the SlimExt\rest\Controller

namespace app\controllers;

use app\models\Tags;
use Slim;
use SlimExt\rest\Controller;

/**
 * Class Test
 * @package app\controllers
 */
class Test extends Controller
{
    /**
     * @return array
     */
    protected function methodMapping()
    {
        $map = parent::methodMapping();
 
        // extra method mapping
        $map['post.local'] = 'local';
        $map['get|post.thirdParty'] = 'thirdParty';

        return $map;
    }

    /**
     * @return Slim\Http\Response|static
     */
    public function getsAction()
    {
        $keyword = $this->request->getTrimmed('keywords','');

        $list = Tags::searchByName($keyword);

        return $this->response->withJson(['list' => $list]);
    }
    
    // 这里的id 可以是 int|string
    public function getAction($id)
    {
        // can also return array. it will be translate to json.
        return [
            'test' => 'data',
            'id' => $id
        ];
    }
    
    public function localAction()
    {
        return $this->response->withJson([
            'token' => 'test'
        ]);
    }

    public function thirdPartyAction()
    {
        return $this->response->withJson([
            'token' => 'test'
        ]);
    }
}