如何使用可选参数设计用于搜索的RESTful URL？

Question

如果我必须在我的RESTful Web服务中创建一个URL,我的客户将使用它来按字段可选的字段搜索所有业务,URL会是什么样的？

企业可以仅通过姓名,姓名和电话号码或姓名,电话号码和联系电子邮件进行搜索.

Answer 1

Chandru,想想所有业务的列表,比如一组具有属性的实体.您可以通过使用URI中的参数来创建标识(选择)子集的URI.

通常这是通过查询字符串参数('？'之后的内容)完成的,但您也可以将参数指定为路径段或矩阵URI.

最典型的方法就是这样

• http://foo.org/service/businesses/?name=acme或
• http://foo.org/service/businesses/?name=acme&phone=12345或
• http://foo.org/service/businesses/?name=acme&contact=smith@bar.org('@ '当然需要URL编码)

它在概念上类似于SQL select子句.

路径段或矩阵参数中的参数对索引可能性有影响(例如,矩阵参数允许您在多个级别进行过滤,因为层次结构可以在病房之后继续,而不能使用查询参数).如果你关心的话,我建议你提出一个不同的问题.

例:

http://foo.org/service/businesses/france/name=acme;city=paris/latest/?contact=xxx

一月