URI構成について - ajiwai-project/ajiwai-api GitHub Wiki

構成メモ

単語について

  • 複数形を使用する
  • 単語の連結は「-」を使う(単語の連結をしたくなったら構成を見直した方がいいかもしれない)
  • IDなどリソースを特定するものはパスに含み、検索に利用するクエリー(取得する数など)はクエリーパラメータを使う

メソッドの役割

GET: データ取得 POST: データ新規登録 PUT: データ更新 DELETE: データ削除 PATCH: データ一部更新

versionについて

含めるか未定

apiのprefixについて

パスではなくドメインに含んだ方がいいっぽい

TODO

swaggerでAPIは管理したい