プログラムの関数やメソッドを呼び出すといったプログラム上のやり取りと同じように、プログラムから別のネットワーク上にある関数を呼び出す仕組みです。

RPCにも種類があり、XML-RPCやJSON-RPCがあります。

最近では「gRPC API」といったRPCの技術を採用したAPIも登場しています。

SOAPはリクエスト・レスポンス共にXML形式でやり取りします。

この送受信されるXML形式をSOAPメッセージといい、headerとbodyに分かれています。

厳格なメッセージパターンで安全性は高いですが、複雑な仕様や負荷が高いため敬遠されるようになりました。

特定のURLにHTTPアクセスすることでJSONやXML形式でレスポンスする仕組みです。

SOAPはプロトコルで厳格なルールが求められるのに対し、RESTは設計思想で柔軟性がありシンプルです。

RESTの設計にはいくつかの制約がありますが、今回は代表的な４つのルールを紹介します。

ちなみに、このルールに従ったREST APIを「RESTful API」と呼びます。

（１）統一されたインターフェイス

以下のようなHTTPで定義されている４つのメソッドを使用するというルールがあります。

・GET（データの取得）
・POST（データの登録）
・PUT（データの更新）
・DELETE（データの削除）

（２）アドレス可能性

情報のやりとりの方法や定義を、あらかじめ統一しておくというもので、どこから呼び出しても同じ形式で呼び出せる必要があります。

例えば「https://api.〇〇/user/」のようなURLにアクセスすればリソースにアクセスできる、といったように取得する情報ごとに識別されているということです。

（３）接続性

１つのリンクから複数の別のリンクに接続できるということです。

つまり、XMLやJSONといったハイパーメディアを使用するということです。

（４）ステートレス性

やり取りをセッション情報などに持たせず、やり取りの情報はその時だけで完結させるということです。

図で表すと以下のようになります。


このように、取得したいデータは一つのリクエストで完結させる必要があります。

APIが叩かれたとき、処理を返却するためのコントローラーを作成していきます。

前回使用したApiコントローラーを使用します。

../cake_pjt/src/Controller/ApiController.php

    /**
     * formデータを返却するAPI
     *
     */
    public function form()
    {
        // Fromsモデルを読み込む
        $this->loadModel('Forms');
        // パラメータを受け取る
        $params = $this->request->getQuery();
        $id = null;
        // 特定のパラメータがあればセットしておく
        if (isset($params['id']) && $params['id']) {
            $id = $params['id'];
        }
        // 条件に合わせてデータを取得する
        if ($id !== null) {
            $form_data = $this->Forms->get($id);
        } else {
            $form_data = $this->Forms->find('all');
        }

        // 返却データをセットする
        $this->set([
            'forms' => $form_data,
            '_serialize' => ['forms']
        ]);
    }

今回は以前作成したFormsテーブルのデータを返却するAPIを作成しました。

上から順に説明していきます。

最初に、Formsテーブルの情報を取得したいため「loadModel」でモデルを読み込んでいます。

中間部分では、パラメータがあるかどうかのチェックを行い、データの取得方法を分岐しています。

ここでは、リクエスト側がIDをパラメータとして渡してくればそのIDのデータのみを返却し、何も渡さなければ全件数を取得するようになっています。

最後に、JSONデータを返却しています。「_serialize」と指定するだけで、JSONまたはXMLデータとして返却されます。

上記で作成したAPIを実行してみましょう。

以下のURLにアクセスします。

http://localhost/cake_pjt/api/form.json


JSONデータが出力されました。

別プロジェクトとありますが、現在使用している「cake_pjt」をコピーし、そこに今回作成したAPIを呼び出す処理を実装して確認してみます。

確認用なのでお好きな名前で大丈夫です。

ここでは「cake_pjt2」という名前でコピーしました。


そのままコピーしたので「cake_pjt2」プロジェクト内にも「ApiController.php」があります。

ここに確認用の処理を書いていきます。

../cake_pjt2/src/Controller/ApiController.php

    /**
     * API取得テスト
     *
     */
    public function apiTest()
    {
        $this->autoRender = false;
        $url = 'http://localhost/cake_pjt/api/form';
        $data = [];
        $option = [
            'headers' => [
                'Accept' => 'application/json'
            ]
        ];
        $http = new Client();
        $response = $http->get($url, $data, $option);
        if ($response->isOk()) {
            $content = $response->getJson();
            debug($content['forms']);
        }
        exit;
    }

最初の「autoRender」はtemplateを使用しないため、falseとしています。

前回ご紹介したAPI取得方法と同じく、Clientクラスを使用します。

まずは全件数のデータを取得します。


全件数取得出来ています！

それでは特定のIDだけを取得してみましょう。

「$data = [];」となっているところを「$data = [‘id’ => ‘2’];」として、ID=2のデータを取得します。


ID指定でも無事取得することができました。