rest - 使用 or 条件定义查询参数的 RESTful 最佳实践是什么？

Question

我想知道，遵循 RESTful 最佳实践，我应该以哪些方式定义如下网址:

/people?q="email=aa@aa.com||phone=11111"

关键是根据他们在搜索框中插入的内容，通过他们的电子邮件地址或电话搜索一个人。

我一直在阅读一些关于使用 RESTful 服务的最佳实践的指南，但似乎没有人谈论这种情况。

Answer 1

REST意味着您通过构建(统一)应用程序接口(interface)来遵循标准。
目前，使用 GET 进行一般查询没有标准解决方案。您可以使用许多非标准 URL 查询语言。例如。 RQL , OData , 大部分数据库 REST API URI 的结构:e.g. mongodb等...所以尽量不要重新发明轮子。作为替代方案，您可以像在示例中那样在查询参数中发送序列化查询。它可以是任何标准查询语言，例如SPARQL如果您将 REST 与 RDF 一起使用像 hydra 这样的词汇.如果您不这样做，那么您必须在您的 vendor MIME type 的文档中描述它。 . (一般查询在这种情况下意味着您不知道查询的结构是什么。)
如果您正在寻找非通用查询解决方案，那么您可以使用任何 URI template只要您以某种方式使用您的 RDF 词汇或在您的供应商 MIME 类型的文档中描述您的链接参数。如果您不明白我在说什么，请查看 manual 的 HATEOAS 部分的统一接口(interface)约束/自我描述消息。或使用 wikipedia . (在这种情况下，非一般查询意味着您对查询结构有一个概念，并且可以使用 URI 模板对其进行描述。)
请注意，您必须解析、验证和授权这些查询，因此发送 SQL 语句并在没有任何检查的情况下通过数据库运行它可能对您的应用程序是致命的。