用途
APIの入出力、認証、エラー仕様を実装前に確認するためのテンプレートです。
このテンプレートに含まれる内容
- API概要
- エンドポイント一覧
- リクエスト仕様
- レスポンス例
- エラー仕様
使い方
- 正常系と異常系を同時に書く
- サンプルJSONを必ず置く
- ステータスコードと業務エラーを分けて整理する
関連しやすい業務領域
API管理、テスト自動化、モックサーバー関連の導線に適しています。
設計書（システム）
API設計書テンプレート
エンドポイント、認証、リクエスト、レスポンス、エラー仕様を揃えます。
スポンサーリンク
Markdownプレビュー
そのままコピーして、社内Wiki、GitHub、Notion、Google Docs などに貼り付けやすい構成です。
# API設計書
## 1. API概要
- API名:
- 目的:
- 認証方式:
- ベースURL:
## 2. エンドポイント
| Method | Path | 説明 |
| --- | --- | --- |
| GET | | |
## 3. リクエスト
### Headers
| Name | Required | Description |
| --- | --- | --- |
| Authorization | Yes | |
### Query / Path Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| | | | |
### Body
```json
{
"sample": "value"
}
```
## 4. レスポンス
### 200 OK
```json
{
"id": "sample"
}
```
## 5. エラー
| Status | Code | Description |
| --- | --- | --- |
| 400 | bad_request | |
| 401 | unauthorized | |
| 500 | internal_error | |
## 6. 備考
-スポンサーリンク