Open2
納得感を持ってスムーズにチームでweb api設計を進めたい
ふじしろ前提
- OpenAPI（Swagger）で設計
- OpenApiGeneratorを利用する
議題
- エンドポイント（URI）の構造
- HTTPメソッドの使い分け方
- HTTPメソッドに当てはまらない例外をどうするか
- ファイルの命名、ディレクトリ構成
意見の一致がスムーズだった点
- リソース+アクションの形でAPIを設計する
- アクションはHTTPメソッドで表す
争点orなんとなくで進んだ点
- リソースを持たない（ように見える）APIの扱い
- HTTPメソッドに当てはまらないアクションを持つ（ように見える）APIの扱い
- ファイル命名規則
- メソッド名
メモ
議論で「REST」というワードは使わないほうが良さそう。認識が人によって違うし、自分の意見の根拠を補強しようとすると根拠が薄いことに気づいて自爆する。
「良いweb apiとは？」という内容で議論したほうが双方幸せ
ふじしろ参考書
基本
発展