REST APIの設計 - 異なるパラメータでRESTを通じてリソースを取得/ポスト/入れよう

Question

RESTfulなAPIデザインに関連する質問があります。 GET/POST/PUTリソース（ユーザー）にRESTfulなAPIがあります。私は私のデザインはここ

正しいかどうか..私はちょうど上記の設計が良いかどうかを知りたいと思った

/users: 
    get:  
    queryParameters: 
     joinDate: 
     displayName: get all used based on join date   
    post: 
    displayName: Add new user 

/{lastName}: 
    get: 
     displayName: Get all users based on last name 
/{id}: 
    put: 
     displayName: Update a particular user 

例です

非常に明確ではないよすべてのヘルプ感謝します！

Answer 1

CRUD（作成、読み取り、更新、削除）は、データリポジトリで実行される基本操作を意味します。レコードまたはデータオブジェクトを直接処理します。これらの操作とは別に、レコードはパッシブエンティティです。通常は、データベースのテーブルとレコードだけです。

RESTはリソース表現を操作し、それぞれがURLで識別されます。これらは通常、データオブジェクトではありませんが、複雑なオブジェクト抽象化です。

たとえば、リソースにはユーザーのコメントを使用できます。つまり、 'コメント'テーブルのレコードだけでなく、 'ユーザー'リソースとの関係、コメントの投稿、それが答える別のコメントなども意味します。

コメントの操作は基本的なデータベース操作ではなく、元のポスターにアラートを発したり、ガマティックなポイントを再計算したり、フォロワーストリームを更新するなどの重大な副作用があります。

リソース表現には、ハイパーテキスト（HATEOASの原則をチェック）が含まれているため、設計者はリソース間の関係を表現したり、操作のワークフローでRESTクライアントを指導できます。

要するに、CRUDは（主にデータベースと静的データストレージ用の）セットプリミティブ操作ですが、RESTは非常に高水準のAPIスタイルです（主にウェブサービスやその他の「ライブ」システム用）。

最初のデータはデータを操作し、もう1つはデータを操作し、もう1つは動作中のシステムとやり取りします。

to Learn more about CRUD

ので、私の観点から、あなたは完全に正しいです！

Answer 2

私はこのようにします。

POST /users 
    Creates a single user 

GET /users 
    Reads all users 

GET /users;joinDate=yyyy-MM-dd 
    Reads all users whose join date matches to given 

GET /users;joinDate=yyyy-MM-dd;lastName=Some 
    Reads all users whose join date matches to given 
    and whose last name matches to given 

GET /users/{userId} 
    Reads a user whose {id} matches to given 

GET /users;joinDate=yyyy-MM-dd/{userId} 
    Reads a user whose id matches to given 
    among those who joined on specified day.