---
# System prepended metadata

title: APIの仕様書の運用

---

# APIの仕様書の運用
## versionについて
### メジャーバージョン
`x.0.0`の用に記述

後方互換性がないやつ
pathに/v1とか/v2とかで切る

### マイナーバージョン
`1.x.0`の用に記述
項目追加したとかそれくらいのやつ

### パッチバージョン
`1.1.x`の用に記述
limitの記載もれやtypoくらいのやつ

## 開発フロー
- 先行して、SwaggerでAPIで新バージョンのタグにbetaというサフィックスをつけてドキュメントを作る
  - `2.1.0-beta`みたいになるのかた
- ステージング環境でAPIの開発をする
  - 開発中はSwaggerも軽微な編集はおｋ
  - ↑なんたって、betaってタグを付けているからね
  - もしかしたら、beta1とかbeta2って履歴管理するかも
- 本番適応おｋでリリースしたら、masterブランチにバージョンのタグを切って、Swagggerもbetaを外したバージョンをつける

### モックサーバ
https://app.swaggerhub.com/help/integrations/amazon-api-gateway

### ToDo
- `{user_id}`の書き方に変える
- Errorのレスポンスのところは繰り返し使えるようにする→ドメイン？
- serversのurlを記載する
- securityの項目を追加する
- docs branding設定する