APIコンポーネント

, _(*1)

要件

CakePHP 2.5+
PHP 5.4.16+

概要

CakePHPでREST APIを実現するためのコンポーネントと、その付属ライブラリ群です。基本的にはコンポーネントを設置し、Routing.prefixesに'api'を含めるだけで使えます。, _(*2)

セットアップ

Configure::write('Routing.prefixes', ['api']); を app/Config/core.php で設定
app/Config/routes.php で以下のルートを作成(プラグインのルートがプレフィックスよりも優先されるため。 require CAKE . 'Config' . DS . 'routes.php';の前に設置)

Router::connect('/api/:controller/:action/*', ['api' => true]);
Router::connect('/api/:controller/*', ['action' => 'index', 'api' => true]);

CakePlugin::load(Api); OR CakePlugin::loadAll() を app/Config/bootstarp.php で設定
使いたいコントローラ(OR AppController)で以下のように設定

$components = [
    'Api.Api'
];
  ```

### コーディング例

#### 新規登録（メールアドレス）

```php
/**
 * signup api
 *
 * @return void
 */
public function api_signup() {
    $this->request->onlyAllow('post');
    $this->Api->recordMap = [
        'User' => [
            'name',
            'email',
            'password',
        ],
    ];
    $params = $this->Api->requireParamsFromMap();
    $data = $this->Api->paramsToRecord($params);

    $this->Api->processSaveRecord($data, [
        'saveCallback' => [$this->User, 'signup'],
    ]);
}

/**
 * login api
 *
 * @return void
 */
public function api_login() {
    $this->request->onlyAllow('post');

    $data = $this->Api->requireParams([
        'email',
        'password',
    ]);
    $this->request->data = ['User' => $data];
    $this->Auth->logout();
    $this->User->useValidationSet(['Login']);
    $this->User->create($this->request->data);
    $loggedIn = $this->User->validates() && $this->Auth->login();
    if ($loggedIn) {
        $this->Api->success();
    } else {
        $this->Api->raiseValidationErrors();
    }
}

コメント取得

App::uses('LackParametersException', 'Api.Error');

Class CommentsController extends AppController {

    /**
     * index api
     *
     * @return void
     */
    public function api_index($postId = null) {
        $this->request->onlyAllow('get');
        if ($postId === null) {
            throw new LackParametersException('postId');
        }

        $this->Api->recordMap = [
            'Comment' => [
                'id',
                'body',
                'created',
                'updated',
            ],
            'User' => [
                '_wrap' => 'user',
                'id',
                'name',
            ],
        ];

        $this->Comment->create();
        $this->Comment->set('post_id', $postId);
        if (!$this->Comment->validates(['fieldList' => ['post_id']])) {
            $this->Api->recordMap = ['Comment' => ['post_id']];
            return $this->Api->processValidationErrors();
        }

        $limit = 20;
        $page = $this->Api->collectParam('page');
        $page = $page ? (int)$page : 1;
        $contain = ['User'];
        $comments = $this->Comment->findAllByPostId($postId, compact('limit', 'page', 'contain'));

        foreach ($comments as &$comment) {
            $comment = $this->Api->recordToParams($comment);
        }
        $this->Api->success(compact([
            'page',
            'limit',
            'comments',
        ]));
    }

}

リクエストの取り扱い

リクエストパラメータとして、GETの場合クエリストリングを、その他の場合はPOST BODYを取り扱います。 $this->request->query か $this->request->data を見ると言い換えることもできます。, _(*3)

レスポンス概要

JSONのみサポートします。
レスポンス構造は固定です。

レスポンス例（成功）, _(*4)

{
    "success": true,
    "code": 200,
    "data": {
        "user": {
            "id": "2081",
            "last_name": "shimizu",
            "first_name": "hiroki"
        },
    }
}

レスポンス例（失敗）, _(*5)

{
    "success": false,
    "code": 400,
    "errorCode": "validation_error",
    "errorMessage": "バリデーションエラー",
    "validationErrors": {
        "id": [
            [
                "exists",
                "valid"
            ]
        ]
    }
}