api - 搜索 API - HTTP 查询参数格式

Question

我为我工作的网站创建了一个搜索 API。例如，它支持的一些查询是:

• /api/search - 返回热门搜索结果
• /api/search?q=car - 返回匹配术语“car”的结果
• /api/search?start=50&limit=50 - 从偏移量 50 开始返回 50 个结果
• /api/search?user_id=3987 - 返回 ID 为 3987 的用户拥有的结果

这些查询参数可以混合和匹配。它是使用 Solr 在后台实现的的分面搜索。

我正在努力添加可以根据数字属性过滤结果的查询参数。例如，我可能只想返回查看次数大于 100 的结果。我想知道指定此项的最佳做法是什么。

Solr是这样使用的:

/api/search?views:[100 TO *]

Google 似乎在做这样的事情:

/api/search?viewsisgt:100

这些似乎都不是很吸引我。是否有指定此类查询词的最佳实践？有什么建议吗？

Answer 1

只需使用“,”作为 from/to 的分隔符，它读起来最好，在我看来很直观:

# fixed from/to
/search?views=4,2

# upper wildcard
/search?views=4,

# lower wildcard
/search?views=,4

我的值(value)观具有包容性。在大多数情况下，您不需要独占/包含的额外语法糖。

绑定(bind)它甚至在一些开箱即用的框架(如 spring mvc)中工作得很好，这些框架将 ',' 分隔值绑定(bind)到值数组。然后，您可以使用特定访问器(getMin()、getMax())包装内部数组。