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

问题描述

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

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

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

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)