在REST端点中使用分号(不用于分隔查询参数)

时间:2013-10-20 18:42:48

标签: api rest api-design

假设您有REST端点/articles。要获得文章,结束点将为articles/:id。现在说,你必须找到带有搜索过滤器的文章,我看到了/articles;find形式的URI(在POST主体中过滤)。我觉得它应该是/articles/find并且前一种方法的已知问题是大多数库都不会正确解析URI。我看一下流行的REST API,我没有看到任何地方的分号方法。但是,我不确定定义查找文章REST端点的正确方法是什么。

1 个答案:

答案 0 :(得分:3)

HTTP提供了一种使用查询字符串进行过滤的方法,过滤器可以充当搜索。因此,您将没有名为“find”的资源,您将在要搜索的资源集合上使用查询字符串,在本例中为articles资源。例如/articles?category=biology。此资源应返回与查询字符串匹配的文章的链接。如果省略查询字符串,它应该返回所有文章的链接。