我应该在 HTTP 请求负载中使用 ID 号还是有意义的文本

Posted 2023-02-19

【中文标题】我应该在 HTTP 请求负载中使用 ID 号还是有意义的文本

【英文标题】：Should I use id numbers or meaningful texts in HTTP requests payload

【发布时间】：2022-01-23 18:35:52

【问题描述】：

我一直在搜索，但找不到任何参考资料来支持我的印象，即在可能值范围有限且范围很小的情况下，在请求正文或响应中使用有意义的文本比仅使用 id 更值得。让我举例说明。我应该使用什么：

 "idSystemStatus": 1

或者那个：

 "systemStatus": "alert"

最佳做法是什么？可以给我参考吗？

【参考方案1】：

作为 API，意味着其他系统会读取它。因此，带宽优化很重要，并且在适当的情况下使用较短的数值是有意义的。

但如果您明确需要措辞，请尽量使其简短明了。

【讨论】：

你有这方面的参考吗？我理解您的担忧，但我不确定最佳做法是什么。另外，我可以将我的示例更改为使用 uid，因此它与一个单词一样长。

没有参考，我根据经验说话。另请查看：***.com/questions/30187323/…，它几乎没有什么好的指针。