restful-api-design
Installation
SKILL.md
Web API Design
Web API の表面設計を、意味・互換性・運用性の観点から判断するためのスキル。
HTTP は単なる配送路ではない。メソッド、ステータスコード、キャッシュ、条件付きリクエスト、表現形式といった既存の意味を壊さずに使うことで、API は理解しやすく、変更しやすく、壊れにくくなる。
このスキルを使う場面
- 新規 API のエンドポイント設計
- 既存 API の URL / HTTP メソッド / レスポンス形状の見直し
- ページネーション、フィルタ、ソート、検索の設計方針決定
- エラーフォーマットやステータスコードの一貫性整理
- 破壊的変更、バージョニング、互換性維持の方針決定
- API レビューでの表面設計の妥当性判断