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

Swagger 向使用ReDoc生成的OpenAPI 3.0规范中添加技术细节的最佳方法是什么?,swagger,openapi,redoc,Swagger,Openapi,Redoc,按照最佳实践,OpenAPI规范应该只包含接口使用信息,而不包含技术/开发人员相关信息 尽管如此,我觉得这是一个很好的地方,可以记录重要的技术细节——例如,实现接口的源代码文件名,计划新特性的Jira ID,等等 如果在ReDoc中正确呈现,请考虑externalDocs字段,或者考虑某种条件ReDoc生成,以生成一个公共API规范和另一个内部API规范,该规范还包含技术细节

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

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

如果在ReDoc中正确呈现,请考虑
externalDocs
字段,或者考虑某种条件ReDoc生成,以生成一个公共API规范和另一个内部API规范,该规范还包含技术细节