API 定義書＠AI 用ドキュメント¶
このドキュメントは、API のバックエンドロジックを実装するためのドキュメントであり、生成 AI に読み込ませることを想定している。
API 概要¶
〇〇における API。
▲ からのリクエストに対し、レスポンスを返却する。
エンドポイント¶
- ドメイン:
example.com - パス:
/api/v1/foo - メソッド: POST
- Content-Type: application/json
リクエスト仕様¶
JSON 例¶
ここでは、データ型名を値の例としている。
{
"user": {
"userId": "string",
"name": "string"
}
}
パラメータ定義¶
| パラメータ名 | 必須/任意 | Type | 説明 |
|---|---|---|---|
user |
必須 | Object | ユーザ情報 |
└ userId |
必須 | String | ユーザーID |
└ name |
必須 | String | ユーザー名 |
レスポンス仕様¶
JSON 例¶
ここでは、データ型名を値の例としている。
{
"code": "string",
"user": {
"userId": "string",
"name": "string"
}
}
パラメータ定義¶
| パラメータ名 | 必須/任意 | Type | 説明 |
|---|---|---|---|
code |
必須 | String | 処理コード |
user |
必須 | Object | ユーザ情報 |
└ userId |
必須 | String | ユーザーID |
└ name |
必須 | String | ユーザー名 |
処理コード一覧¶
| コード | 説明 |
|---|---|
00 |
正常 |
01 |
処理中 |
02 |
処理失敗 |
03 |
処理なし |
99 |
処理エラー |