URI 和响应中参数的 API 最佳实践

Posted 2023-02-22

【中文标题】URI 和响应中参数的 API 最佳实践

【英文标题】：API best practice for parameters in URI and response

【发布时间】：2021-12-19 19:05:38

【问题描述】：

我正在尝试遵循 API 的最佳实践，但我得到的建议相互矛盾。大多数人建议对 URI 使用脊柱大小写（例如 *** 和 RFC3986。 我有一个 API，允许通过各种参数过滤 GET 请求：

GET /endpoint?my-parameter=true

但是，我也在 GET 响应和 PATCH 请求中使用相同的参数。在那里，我看到了更多的camelCase 或snake_case，spine-case 是一个额外的语言，不允许在变量名中使用连字符。所以我用这个：

    
      myParameter: true
   

这似乎不一致。处理这些案例的最佳做法是什么？

【问题讨论】：

没有最佳实践，只是内部保持一致。很多人使用不同的“案例”，所以如果您希望您的正文和网址之间更加一致，请更改一个。

【参考方案1】：

正如埃弗特所说，这个问题没有正确答案。

spinal-case 被排除在外，因为它不适用于 javascript 等某些语言的基本语法格式。 例如：response.user-name 会中断，它必须写成 response[“user-name”]

所以，我们只剩下camelCase 和snake_case。其中，我个人更喜欢snake_case，因为它在区分单词方面比camelCase更清晰。

因此，使用哪一个完全取决于您的意见，但请确保您在所有 API 中都遵循它。