第六に、インターフェイスのドキュメント
1、インターフェイスコンテンツ
インタフェース名
シーン記述
インターフェイス説明
リクエストパラメータ
応答パラメータ
エラーコード
図2に示すように、コンテンツ要求パラメータ
フィールド名
必須
種類
のサンプル値
説明
図3に示すように、パラメータの内容に応じて
フィールド名
説明
例に戻ります
図4に示すように、エラーコードの内容
名前
説明
理由
ソリューション
5、例
6.運動(インタフェースのドキュメント)
管理者/コントローラ/ Goods.phpインタフェースへの保存方法
①ログイン認証ベースのコントローラ、コメント。
②SAVE2メソッドに保存する方法のコードをコピー
③SAVE2パラメータ検証(goods_logoフィールドの検証を追加トークンルールの削除、)改質方法は、ルール
④修正ます$ this->エラーとの$ this - >コードの成功部分は、このコードの)(JSON戻ります。
⑤ファイルアップロードメソッド呼び出しのコメント
⑥郵便配達テストSAVE2インタフェースにより、
⑦ライト・インタフェースのドキュメント
7、練習(プロジェクトのビルド)
図1に示すように、取付フレーム展開TP(抽出アーカイブ設定仮想サイト)(メインドメイン、サブドメイン、およびそのようなwww.pyg.com adminapi.pyg.com)
図2に示すように、モジュール分割(バックグラウンド・モジュール管理者、受信モジュールホーム、舞台裏インターフェースモジュールAdminAPIを、共通モジュール共通)
3、管理モジュール、ホームモジュール、AdminAPIをコントローラモジュールのデフォルトのメソッド、あなたがアクセスすることができます。共通のモジュールで必要な唯一のモデルのディレクトリをモデル化
4、ルーティング構成:AdminAPIをドメインモジュールの構成をルーティング
5、AdminAPIをモジュールへの試みは、ベースコントローラを作成し、メソッド定義OK方法は、クイックリターンのために得られたデータをフェイル
例えば:
失败时,以下两行代码 效果一样
return json(['code' => 401, 'msg' => '参数错误', 'data' => []]);
//$this->fail(401, '参数错误');
成功时,以下两行代码 效果一样
return json(['code' => 200, 'msg' => 'success', 'data' => $data]);
//$this->ok($data);