0

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

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

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

4

0 回答 0