API 概要（Overview）テンプレート
API 全体の設計を伝えるページです。認証・バージョン・エラーモデルを 1 ページにまとめます。
Base URL
すべてのエンドポイントの共通プレフィックスです。
https://api.example.com/v1認証
Authorization: Bearer <token>ヘッダで認証します- トークンは管理画面から発行します
- 有効期限は 24 時間です
バージョン
- 互換性のない変更は
/v2のようにメジャーバージョンを上げます - 後方互換の追加のみ、マイナーバージョン内で行います
エラー
| ステータス | 意味 |
|---|---|
| 400 | リクエスト不正 |
| 401 | 未認証 |
| 403 | 権限なし |
| 404 | リソースなし |
| 429 | レート制限 |
| 500 | サーバー内部エラー |