大佬教程收集整理的这篇文章主要介绍了在 Open API Doc 中包含多个文件路径,大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
我有一个很大的 API,有很多轮子在转动。将所有这些记录在一个巨大的 @H_674_3@openAPI.yaml 文件中对我来说并不容易,因此我决定将文档分解为单独的 @H_674_3@paths,如下面的屏幕截图所示:
现在在我的 @H_674_3@customer.yaml 文件中,我有以下路线:
@H_674_3@/customers/new: /customers/login: /customers/logout:
在我的 @H_674_3@partner.yaml 文件中,我有以下路线:
@H_674_3@/partners/new: /partners/login: /partners/logout:
现在我将上述两个文件包含到我的最终 @H_674_3@index.yaml 文件中,如下所示
@H_674_3@paths: - $ref: "./paths/partner.yaml" - $ref: "./paths/customer.yaml"
但是 @H_674_3@swagger-cli 最终生成的文档在路径引用之前添加了 @H_674_3@- 字符,从而导致文档格式错误且无法使用。
我该如何解决这个问题?
@H_674_3@paths 在 OpenAPI 中是一个映射,而不是一个数组,因此您不能使用 yaml @H_674_3@- 语法。
您需要在顶级文件中包含 pathItem 键,并将 @H_674_3@$ref 放在相关文件或文件片段中。
例如:
@H_674_3@paths: /foo: $ref: "./foo.yaml" /bar: $ref: "./paths.yaml#/paths/bar"
以上是大佬教程为你收集整理的在 Open API Doc 中包含多个文件路径全部内容,希望文章能够帮你解决在 Open API Doc 中包含多个文件路径所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。