如何解决REST 文档是否必须包含每个请求参数的所有可能值?
在编写 REST 文档文档时,是否编写每个请求参数的所有可能值?我认为即使有很多其他方法可以获取源代码等信息,它也会更好。但我不确定。是否有正确答案,或者这只是团队政策的问题?
解决方法
我认为这个问题的答案取决于您所从事的项目。如果这个 API 将被许多其他开发人员使用并向所有人开放,我认为最好使用不同的语言放置一些示例代码片段,并解释每个参数,例如用途和应考虑的限制。我认为在简单地解释每个参数本身之后,您不需要放置所有可能的组合。您可以查看流行的项目 API 文档以获得一个想法;例如:
这些文档提供了开发人员需要的每一个细节。如果此 API 仅适用于您的小团队,并且您不需要如此详细的解释,则可以使用 Swagger 之类的工具轻松记录您的 API。
,我完全同意上面的,只是想添加另一个方便的东西。您可能希望 Postman Collection 包含所有测试用例场景。当您想与团队或 QA 共享它时,这将派上用场。有一种做法是将 Postman 集合保持在源代码控制中并根据需要更新它们。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。