API設計書テンプレート

# API設計書（シンプル）

## 1. API概要
- API名:
- 目的:
- 認証方式:

## 2. エンドポイント
| Method | Path | 説明 |
| --- | --- | --- |
| GET |  |  |

## 3. 入出力
- リクエスト:
- レスポンス:

## 4. エラー
-

# 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. 備考
-

---

# API設計書（詳細版の追加項目）

エンドポイント、認証、リクエスト、レスポンス、エラー仕様を揃えます。

## 詳細: 前提・制約
- 利用できる既存資産:
- 技術的な制約:
- 運用上の制約:
- 法務・セキュリティ上の制約:

## 詳細: 受け入れ条件
| 観点 | 条件 | 確認方法 |
| --- | --- | --- |
| 業務 |  |  |
| 品質 |  |  |
| 運用 |  |  |

## 詳細: レビュー観点
- [ ] 目的とスコープが関係者間で一致している
- [ ] 例外ケースとエラー時の扱いが明確
- [ ] セキュリティ、権限、監査ログの観点が確認されている
- [ ] 実装・テスト・運用の担当が明確

## 詳細: 未決事項
| 内容 | 担当 | 期限 | 状態 |
| --- | --- | --- | --- |
|  |  |  | Open |