微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

将技术细节添加到使用 ReDoc 生成的 OpenAPI 3.0 规范的最佳方法是什么?

如何解决将技术细节添加到使用 ReDoc 生成的 OpenAPI 3.0 规范的最佳方法是什么?

根据最佳实践,OpenAPI 规范应仅包含接口使用信息,而不包含技术/开发人员相关信息。

尽管如此,我觉得这是一个记录重要技术细节的好地方 - 例如实现接口的源代码文件名、计划新功能的 Jira ID 等。

考虑 auth_code 字段是否在 ReDoc 中正确呈现或某种有条件的 ReDoc 生成,以生成一个公开的和另一个包含技术细节的内部 API 规范。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。