REST 文档是否必须包含每个请求参数的所有可能值？
Does REST doc have to contains all possible values of each request parameter?
写REST doc文档的时候，把每个请求参数的所有可能值都写出来好不好？我认为它更好，尽管有许多其他方法可以获取源代码等信息。但我不确定。是否有正确答案，或者这只是团队政策的问题？
我认为这个问题的答案取决于您正在进行的项目。如果这个 API 将被许多其他开发人员使用并向所有人开放，我认为最好使用不同的语言放置一些示例代码片段并解释每个参数，例如用途和限制应该被考虑到。我认为你不需要在简单地解释每个参数本身之后就把所有可能的组合都放在一起。您可以查看流行的项目 API 文档来获得一个想法；例如：
这些文档提供了开发人员需要的每一个细节。如果此 API 仅适用于您的小团队并且您不需要如此详细的解释，您可以使用类似 Swagger 的工具轻松记录您的 API.
我完全同意上面的说法，只是想补充一个方便的东西。您可能希望拥有包含所有测试用例场景的 Postman Collection。当您想要与团队或 QA 共享时，这会派上用场。有一种做法是将 Postman Collections 保留在源代码管理中并根据需要更新它们。
写REST doc文档的时候，把每个请求参数的所有可能值都写出来好不好？我认为它更好，尽管有许多其他方法可以获取源代码等信息。但我不确定。是否有正确答案，或者这只是团队政策的问题？
我认为这个问题的答案取决于您正在进行的项目。如果这个 API 将被许多其他开发人员使用并向所有人开放，我认为最好使用不同的语言放置一些示例代码片段并解释每个参数，例如用途和限制应该被考虑到。我认为你不需要在简单地解释每个参数本身之后就把所有可能的组合都放在一起。您可以查看流行的项目 API 文档来获得一个想法；例如：
这些文档提供了开发人员需要的每一个细节。如果此 API 仅适用于您的小团队并且您不需要如此详细的解释，您可以使用类似 Swagger 的工具轻松记录您的 API.
我完全同意上面的说法，只是想补充一个方便的东西。您可能希望拥有包含所有测试用例场景的 Postman Collection。当您想要与团队或 QA 共享时，这会派上用场。有一种做法是将 Postman Collections 保留在源代码管理中并根据需要更新它们。