2 つの部分に分割されたアプリケーションがあります。
- 管理者 - データが変更される場所
- Public - データが読み取られる場所
この機能を提供する REST API の作成を検討しています。CRUD 操作がどのように表されるかを理解するのは非常に簡単ですが、個々のリソースに対する特定の操作 (コマンド) についてはよくわかりません。たとえば、「公開」するProject
には、「PublishCommand」を送信します。プロパティを に設定しProject
てサーバーに完全に戻すことはしません。Published
true
同様に、RPC タイプのサービスとして分類されることなく、リソースに対するより高度なクエリ操作をどのように表現すべきかについて、私は少し混乱しています。
Project
以下に、リソースの URI テンプレートをリストしました。真の RESTful API を作成するための正しい方向に進んでいますか?
ADMIN API
---------
// Project Resources
GET /projects -- get all projects
POST /projects -- create a new project
// Project Resource
GET /projects/10 -- get project with id 10
PUT /projects/10 -- update project with id 10
DELETE /projects/10 -- delete project with id 10
// Project Resource Operations
POST: /projects/10/publish -- publish project with id 10
POST: /projects/10/unpublish -- unpublish project with id 10
POST: /projects/10/setposition/2 -- move to position 2 in projects list
// Project Sub resources (identity is local to project)
POST: /projects/10/media -- adds media to project with id 10
PUT: /projects/10/media/5 -- updates media id 5 for project id 10
DELETE: /projects/10/media/5 -- deletes media id 5 from project id 10
PUBLIC API
----------
GET: /projects -- gets all projects (with default limit e.g. first 10)
GET: /projects?skip=10&take=10 -- gets projects 11 to 20
GET: /projects/tagged/rest OR /taggedprojects/rest -- gets projects tagged with "REST"
GET: /projects?orderbydesc=publishdate OR /latestprojects -- gets latest projects
GET: /projects/10 -- gets project with id 10