api - ネストされたリソースに名前を付けるための REST のベスト プラクティス

Question

現在、次のリソースがあります。

/api/user/12

id=12 のユーザーに関する情報を返します

/api/user/12/trips

ユーザー 12 が行った旅行のリストとその情報を返します

ただし、/trip/ は別のリソースと考えているため、これは次のように続きます。

/api/trip/5

id=5 の旅行に関する情報を返します

これはこれを行う良い方法ですか？

Answer 1

ベスト プラクティスは、ドメインへのパスを使用することです。

特定のユーザーを表示するには:

/api/user/{username}

すべてのユーザーを表示するには:

/api/user

すべてのユーザーをフィルタリングするには、クエリを使用します。

/api/user?region=Italy

ここに素晴らしい記事があります: http://developer.immobilienscout24.de/wiki/Path_and_Query_Parameters

Answer 2

リソースに名前を付けるには、常に複数形を使用する必要があります。

/api/users

意味: すべてのユーザー (コレクション)。

/api/users/12

意味: ユーザー 12。

特定のリソースに関連するネストされたリソースについては、次のことができます。

/api/users/12/trips

意味: 12tripsのすべてuser。

tripただし、この URI を使用して特定のものを記述することはできます。

/api/trips/5

意味：トリップ5。