このマニュアルは、APIの仕様の検証も兼ねてドキュメント作成を実施する事を想定しています。
ドキュメントの校正については、APIドキュメント校正ルール に従います。
APIドキュメントの作成については、最新版の開発コードでローカル環境を構築し、実際に、APIリクエストを送信しつつ、仕様を確認しながら作成していきます。
Talend API Tester など、Chrome上で、簡単にAPIのテストが行えるものを準備します。
管理画面にログインします。
管理画面にログインした状態であれば、同一セッションの場合、セッション認証にてAPIを送信することができるので、認証に必要なJWTトークンの付与を省略できます。
Web API一覧 のうち「仕様書」欄に「●」が入力されていないものを選択します。
（Talend API Testerを利用する場合）
Talend API Tester における Service は整理用のフォルダのようなものです。複数のテストを行う場合、混乱しないように作っておきます。Service 名はコントローラー名にします。
例）ContentsController の場合、Contents
（Talend API Testerを利用する場合）
Service の画面から、「Add a request」をクリックし Request を作成します。Request名は、アクション名にします。
例）add / edit / delete
メソッド名とURLを入力し、まず送信します。
PHPプログラム側の Warning 等、正常なレスポンスが返って来ない場合、修正できるようであれば修正し、修正しない場合は Issue を作成します。
コントローラーアクションのシグネチャー、また、プログラムのサービスクラスを読んで、パスパラメーター、クエリパラメーターを調査します。
パスパラメーター、クエリパラメーター、リクエストボディについてAPIドキュメントに記載します。
データベース設計書 を参考にリクエストボディを作成し、送信テストを行います。
パスパラメーター、クエリパラメーター、リクエストボディについてAPIドキュメントに記載します。
add や post のようにデータを保存する場合、データに問題があった場合には、errors キーとして入力エラーの内容を返却します。
もし、バリデーションを通ったデータが不完全な場合には、バリデーションを見直します。
API Testerの結果となる JSON をコピーボタンからコピーして、レスポンスボディに貼り付けて調整します。