API デザイン : URL には名前と識別子のどちらを使うべきか | Google Cloud 公式ブログ

ウェブ API の設計に携わっている方であれば、API で使う URL のスタイルに統一的な考え方がないことも、選択した URL スタイルが API の使いやすさや寿命に大きな影響を与えることも、よくご存じでしょう。Google Cloud の Apigee チームは、社内だけでなくお客様とも協力しながら、API の設計について長く検討を行ってきました。本稿では、私たちが設計の現場で実際に使用している URL のデザイン パターンと、それを使う理由についてシェアしたいと思います。 著名なウェブ API をご覧になれば、いくつかの異なる URL パターンがあることに気づかれるはずです。次に示すのは、極端に異なる考え方に基づいた 2 つのスタイルの具体例です。 https://ebank.com/accounts/a49a9762-3790-4b4f-adbf-4577a35b1df7 htt

[teracy_junk]

『識別子はルックアップ用、名前は検索用』

[braitom]

APIのURLパターンを識別子にするか階層構造の名前にするかについて。どちらか選ばずに両方をサポートする、識別子はルックアップ用、名前は検索用。

[nobuoka]

名前 (変化しうるもの) を含む URL は検索のようなものとみなし、それとは別にリソースを一意に特定できる値を含む URL も用意するという設計

[progrhyme]

両方をサポートするという選択肢

[dekokun]

「識別子はルックアップ用、名前は検索用」

[umaemong]

メモ。個々の記事にはpermalinkが振られてるけど最新記事はlatestで参照できるのも同じ発想だよね。納得感ある。

[tinsep19]

名前はクエリか。そうだな

[koheikimura]

“最良の答えは、選ばないことです。必要な機能を完全にサポートするには両方が必要です。”

[turanukimaru]

識別子はオブジェクトそのものを指すけど検索用の名前は「その名前を持つ者すべて」を指すので集合になる。集合なので空になったり複数になったりもする。どちらを使うべきかは本当に難しい。

[itochan]

なぜだか URI って単語を思い出した。

[t-tanaka]

このブクマページが http://b.hatena.ne.jp/entry/348406869 と http://b.hatena.ne.jp/entry/s/cloudplatform-jp.googleblog.com/2017/11/API-design-choosing-between-names-and-identifiers-in-URLs.html の二つのURLを持つようなもの。

[beerbeerkun]

なんだろこのページ、延々とリロードされるんだけど

[AKIMOTO]

結婚したからって一つ上のフォルダの名前を変えると不便だね。納税やら犯罪歴やらはマイナンバーで追跡すれば良い、と

[rinsuki]

なるほどなあ / example.comとか.example使わなくて良いんですか