rest - コレクションをフィルタリングするURLを記述するRESTfulな方法はありますか？

Question

コレクションを表すURLがある場合、フィルターを説明する良い方法はありますか？

e.g. http://example.com/comic_books?after=2001-01-01&before=2002-03-09

これらのフィルターをサービス契約の一部にすると、アプリケーション状態のエンジンとしてのハイパーメディアの概念に違反しませんか？

コレクションにリンクし、たとえばHTMLフォームを介してフィルターを説明する別のリソースが必要ですか？

Answer 1

HTMLフォームは、リソースとフィルターを表すURLテンプレートと見なすことができます。これには何の問題もありません。私たちは毎日それを行っています（google.com？s = query）。URLテンプレートを表すためのフォームは必要なく、ドキュメントだけで十分であると主張する人もいます。そのため、多くの場合、フォーム自体はオプションです。

ハイパーメディアの側面は、主にリンク自体の存在に関連しています。サービスの文書化は「帯域外」の考慮事項ではありません。ただし、必要なのは、クライアントがたどることができるハイパーメディアの一部としてリンクオプションを提示することです。フォームは素晴らしい場合がありますが、必須ではありません。ペイロードの一部として明示的にリストすることなく、フィルターに同じリンクおよびクエリパラメーターを使用できます（必要な場合もあります）。

HTMLの代替としてHALを検討してください。これにはフォームの概念がありませんが、多くの人がハイパーメディアと互換性のある優れたメディアタイプであると考えています。