34

クエリ パラメータを使用して RESTful 検索 URI を設計したいと考えています。たとえば、次の URI はすべてのユーザーのリストを返します。

GET /ユーザー

そして、姓が「Harvey」の最初の 25 ユーザー:

GET /users?surname=Harvey&maxResults=25

ハイパーメディアを使用して、「/users」リソースで許可されているクエリ パラメータを説明するにはどうすればよいですか? 新しいGoogle Tasks APIでは、リファレンス ガイドにすべてのクエリ パラメータが記載されているだけであることに気付きました。リストを文書化しますが、HATEOAS でもやりたいと思います。

前もって感謝します！

4

3 に答える 3

22

URI テンプレート仕様の現在のドラフトで説明されている構文を使用すると、次のようになります。

/users{?surname,maxresults}
于 2011-05-16T19:26:13.657 に答える
6

もう1つのオプションは、htmlフォームを使用することです。

<form method="get" action="/users">
   <label for="surname">Surname: </label>
     <input type="text" name="surname"/>
   <label for="maxresults">Max Results: </label>
     <input type="text" name="maxresults" value="25"/> <!-- default is 25 -->
   <input type="submit" name="submitbutton" value="submit"/>
</form>

このようなフォームは、使用可能なオプションとデフォルトを完全に文書化しており、指定されたURLを作成し、そこに配置したい追加の文書で注釈を付けることができます。

于 2011-05-17T00:12:24.943 に答える