搜索参数的REST API命名约定

时间:2017-11-17 09:53:41

标签: rest naming-conventions

我需要为我的应用程序格式化RestAPI。此API根据搜索查询参数过滤数据。我需要了解在命名约定方面处理搜索查询参数键的正确格式是什么(camelCase / snake-case)

以下只是一个假设的例子。我专注于找到RestAPI的搜索参数所遵循的确切案例

- 问题1:当密钥是多个单词的组合时,哪个是用于搜索查询参数键的正确套管格式。 例如:以下哪一项是正确的:....?searchType=A....?search_type=A

- 问题2:假设我有5种搜索类型,并且对于每种搜索类型,都有一个要搜索的值。因此,要在搜索查询参数中发送此值,应该只有一个“值”的通用键,或者如果我可以对每个搜索类型使用“a”,“b”等。 例如:

格式1:....?search_type=A&a=testvaluea / ....?search_type=B&b=testvalueb

格式2:....?search_type=A&value=testvaluea / ....?search_type=B&value=testvalueb

我正在固定以下功能的格式1 cz:

- 使用“a”和“b”等搜索参数可确保对于特定搜索类型我们可以预期某个参数。

- 这应该是一种糟糕的方法,因为各种形式的数据都是在特定的搜索参数中发送的。

1 个答案:

答案 0 :(得分:0)

REST 并不关心您用于URI的拼写。

编码到URI中的信息由服务器自行决定,并供自己使用。

  

当密钥是多个单词的组合时,哪个是用于搜索查询参数键的正确套管格式

无论符合您当地的拼写惯例;它在这方面就像一个变量名。

  

应该只是" value"的一个通用键。或者如果我可以使用" a"," b"等每种搜索类型。

再次遵循当地惯例。

如有疑问,请记住REST的参考实现是Web。当您在网上填写表单时,您不必关心变量名称是什么。表单会告诉您变量名称是什么,浏览器会为您完全自动化该过程。