URI（URL）の設計とパラメーターの使い分けの紹介

概要

• URI（URL）の設計で意識すべき事とパラメーターの使い分けについてまとめる。

ご注意

• 本件は筆者の主観によるものが大きいです。
• URI設計する時に筆者はこんなことを意識しているんだなあ。くらいの気持ちで参考程度に御覧ください。

URIについて筆者が意識していること

1. ぱっと読んでどのようなリソースに向けたURIなのかわかりやすいものにする。
   1. 冗長なパスを避ける
   2. パスに日本語を入れない（一見わかりやすいように見えるがエンコードが必要なため）
   3. 開発者の意図だけの省略文字などを使わない（userをuを省略することや、alphaやbetaなど）
2. 統一感を大切にする。
   1. 大文字 or 小文字で統一
   2. 複数形の単語を用いる
   3. 単語を連結する場合ハイフンで（ケバブケースを用いる）
   4. パラメーターの値取得のルールを統一（パスパラメーターを使う？クエリパラメーターを使う？ 先にルール決めしてそのルールを全体に反映させる）
3. セキュリティー面の安全性を意識する。
   1. .phpなどの拡張子をパスに含めない

パラメーターについて筆者が意識していること

• こんな時はパスパラメーターを検討
  • 必ず特定のひとつの情報だけを返す場合
    • 単一なユーザーの情報取得等
• こんな時はクエリパラメーターを検討
  • nullableな値の場合
    • user_idが指定されている時は特定のユーザーを、指定されていないときはすべてのユーザーを返す時等
    • 一覧の絞り込み条件等