読み取り専用と編集可能なリソースをRESTスタイルで取得するにはどうすればよいですか？

Question

私はRESTの原則にかなりよく知っているし、関連する論文、Wikipediaのエントリ、ブログ記事の束と被写体上のStackOverflowの質問を読んでいるが、それでも一般的な場合には簡単な答え見つけていない：

を

私は表示するリソースを要求する必要があります。リソースの状態に応じて、私は読み込み専用か編集可能な表現のどちらかをレンダリングする必要があります。どちらの場合でも、私はリソースを取得する必要があります。読み取り専用または編集可能なバージョンを取得するURLを作成するにはどうすればよいですか？

私のユーザーがGET /resource/<id>へのリンクをたどっている場合は、読者のみが読み込み専用の表現を必要としていることを示すだけで十分です。しかし、編集可能なフォームをサーバーに置く必要がある場合、そのURLはどのように見えますか？ GET /resource/<id>/editは明らかですが、URLに動詞が含まれています。 GET /resource/<id>/editableにそれを変更することで、この問題は解決されていますが、見た目は明らかに表面的なレベルです。動詞を形容詞に変えることがすべてあるのでしょうか？

代わりにPOSTを使用して編集可能なバージョンを取得する場合、最初に取得したPOSTと保存しているPOSTを区別するにはどうすればよいですか？ POSTを使用する私の（弱い）言い訳は、編集可能なバージョンを取得するとサーバーの状態が変わるということです：リソースをロックします。しかし、それは私の要求がそのようなロックを実装する必要がある場合にのみ成立します。常にそうであるとは限りません。同じ理由でPUTが失敗します。また、実行中のWebサーバーでPUTがデフォルトで有効になっていないため、使用しない実用的な理由（およびDELETE）があります。

編集可能な状態であっても、まだ変更を加えていないことに注意してください。おそらく私がリソースをWebサーバーに再度提出すると、私はそれをPOSTします。しかし、私が後でPOSTできる何かを得るためには、サーバーは最初にに対応しなければなりません。

私は別のアプローチは、コレクションレベルで別々のリソース持っているだろうと思います： GET /read-only/resource/<id>とGET /editable/resource/<id>またはGET /resource/read-only/<id>とGET /resource/editable/<id>を...しかし、それは私にはかなり見苦しいです。

思考？

Answer 1

1）2つの異なるリソース（表示用とドメインコンセプトの編集用）を持つことは完全に有効です。 RESTの観点からは2つの異なるURIであるため、2つの異なるリソースであることに注意してください。ドメインオブジェクトとリソースを競合させる人があまりにも多い。だからこそ、彼らはCRUDをしているだけで立ち往生してしまうのです。

2）リソースの名前にぎこちないようにしないでください。重要なことは、URIが指していることが「もの」、つまり「リソース」であることを認識していることです。それがeditの代わりにeditableでより明白な場合は、それを使用してください。あなたのURLに動詞を付けるだけで、アプリケーションが間違ってしまうことはありません。それは、人間開発者にとって読みにくいものになります。 URLの動詞を使用してHTTPメソッドのセマンティクスを再定義しようとすると、これは統一インターフェース制約の違反です。

Answer 2

代わりにPOSTを使用して編集可能なバージョンを取得すると、最初に取得したPOSTとそれを保存しているPOSTを区別できますか？

リソースを読み込むためにGET（POSTではなく）を実行し、リソースを書き込むにはPOST（またはPUT）を実行します。

問題のリソースに対してロックを作成する場合は、POSTを使用してリソース（またはPOSTの本体にエンコードされたリソースIDを持つリソースのコンテナ）に書き込み、サーバーでロックを作成させますを新しいリソースとして追加し、そのリソースのIDをPOSTへの応答として返します。

（ご質問や、この答えの範囲を超えて認証の問題で）その後のいずれか、ロックを解除するロックリソースにDELETEを使用するか、またはPOSTロックのコンテナへ。

Answer 3

読み取り専用または編集可能なバージョンを取得するためにURLを作成するにはどうすればよいですか？

ここには、最初にURLを構築していることがあります。ハードコードされたURLにIDを追加することは、RESTではありません。 Roy Fielding has written about this very mistake。どちらの文書でもリソースを編集するかどうかを尋ねるメッセージには、そのリソースの編集可能なバリアントへのURIが含まれている必要があります。それが/resource/editableか/editable/resourceであるかどうかは、そのURIに従ってください。

Answer 4

RESTでは、既存のリソースの編集は、クライアントがそのリソースの表現を取得し、表現を変更してから、新しい表現のPUTをサーバーに戻して実行します。

だからあなたのRESTクライアントプログラムはどうしたらリソース読むために：

GET http://www.example.com/SomeResource 
... edit it ... 
PUT http://www.example.com/SomeResource 

通常、同時更新がさせることで処理されます。そのリソースは

GET http://www.example.com/SomeResource 

そして編集することをサーバに到着した最後のPUTは、それがより新しい状態を表すと仮定して、以前のものを上書きする。しかし、あなたの場合は、これを守ることを望みます。

メインリソースごとにオプションの並列ロックリソースを維持するための@ Jasonの提案を慎重に検討してください。あなたのクライアントは最初にロックを作成し、編集してロックを削除します。ロックを行ったユーザーがその後変更を保存しないと、システムは自動的にロックを解除する必要があります。これは、次のようになります。

GET http://www.example.com/SomeResource  
... user presses an edit button ... 
PUT http://www.example.com/SomeResource/lock  
... user edits the resource's representation ... 
PUT http://www.example.com/SomeResource 
DELETE http://www.example.com/SomeResource/lock 

ユーザーが他の誰かによってロックされているリソースを編集しようとしている場合は、いくつかの適切なエラー処理を行う必要があると思います。

現在のHTMLの制限に縛られているように感じます。 Restlet（Javaの場合）のようなサーバー側のRESTフレームワークを使用する場合は、POSTを使用できますが、method = PUTまたはmethod = DELETEのようなクエリ文字列引数を指す "overloaded POST"という概念がサポートされています。独自のサーバーサイドコンポーネントを作成する場合は、このトリックも使用できます。

HTMLレベルでもプレイできるトリックがあります。たとえば、ページに最初に表示される読み取り専用の部分（および）が最初は表示されません。ユーザーが編集ボタンを押すと、JavaScriptは読み取り専用部分を隠し、入力フォームを表示します。

RichardsonとRubyのRestful Web Services（O'Reilly）も必ずお読みください。非常に便利です。

Answer 5

フォームの返却や値の単なる値は、RESTサーバーまでですが、クライアントの責任ではありません。リソースが編集可能かどうかは、リソースのプロパティであり、URLによって定義されたものではありません。

つまり、リソースを取得するためのURLはGET /resource/<id>です。これには編集可能なプロパティがあります。ユーザーがフォームを必要とする場合は、同じURLからリソースを取得してフォームに入力できます。クライアントは、PUT/POST変更よりも可能です。

Answer 6

あなたの質問は、「PUTアクションでGETアクションで返される読み取り専用表現を特定する方法」でしょうかと思います。これを行うことができます：

<Root> 
<readonly> 
<p1><p1> 
... 
<readonly> 
<others> 
... 
<others> 
<Root> 

PUTから要求XMLを解析した後、読み取り専用部分を無視して他のものを処理することができます。レスポンスで200のステータスを返し、読み取り専用の部分が無視されているというメッセージを残します。 それはあなたの期待ですか？