[API] 　仕様書　作成方法　フォーマット

2022/11/20 技術報告

こちらのサイトを参考にさせていただいております。

https://qiita.com/sunstripe/items/9230396febfab2eae2c2

API一覧

API一覧
No. API機能No. 種別 API名 機能概要
0 API_LOGIN API 例 例
1 HOGE-001 API ほげほげ ほげほげする
2 HOGE-002 API ほげほげ ほげほげする
3 HOGE-003 API ほげほげ ほげほげする

LOGIN-001

API機能No. HOGE-000
API名 ログイン制御
更新日/更新者 20XX.XX.XX 担当者名
概要

 

入力
アクセスURI api/hoge/search

リクエストパラメータ（クライアントから送るほう）

POSTデータ（JSON形式）
JSON Key 型 サイズ 必須 暗号化 検索条件 値の説明
user_id 文字列 10 ○ 完全一致 半角数字10桁

レスポンスパラメータ（戻ってくるやつ）

出力
返却データ（JSON形式）
JSON Key 型 サイズ 必須 繰返 値の説明
status 数値 ○ 　処理結果ステータス
messages 配列 　エラーメッセージ群
result 配列 　検索結果は配列
　hoge_id 数値 10 　ほげのID
　hoge_type 数値 1 　ほげの識別番号
　hoge_title 文字列 150 　ほげのタイトル
　hoge_body_text 文字列 　ほげの本文
　hoge_display_date 文字列 10 　表示日時 日付形式（YYYY/MM/DD）
メッセージ

処理結果ステータス

ステータス 共個 メッセージ内容(message)
1 個別 検索結果が1件以上の場合 => {“メッセージなし。”} 検索結果 0 件の場合 => {“該当する情報はありませんでした。”
200 共通 ログアウトしています。
300 個別 { “○○は必須です”, “△△は数値ではありません”} ※ 項目毎のエラー内容を返却
600 個別 {“サーバで認証エラーになりました。”}
999 共通 {“システムエラーが発生しました。”}


メルマガ登録をお願いします。

素敵な？情報がいつもあなたに届くようになります。（itmnewsの記事が届きます。）お役に立つかどうかわかりませんが頑張りますっ。登録してみてください。