【发布时间】:2020-12-03 17:30:41
【问题描述】:
对于我的 springboot 项目,我使用 OpenAPI 3.0.3 和 springfox(3.0.3) 来编写 API 文档。我想以 YAML 格式生成 API 文档,而不是 JSON。默认情况下,springfox 会生成 JSON。 我已经研究过使用 springdoc-openapi-ui 而不是 springfox(springdoc 可以选择 YAML 格式),但是我必须更改所有注释等等。
我想知道是否有办法让 springfox 生成 yaml 而不是 json。
谢谢!
【问题讨论】:
-
YAML 是 JSON 的超集,因此生成的 JSON 也是有效的 YAML,可以这样加载。
-
我知道例如 swagger-ui 两者都读。但是,要求是调用端点获取API文档时,需要以YAML格式获取
-
正如我所说,生成的 JSON是 有效的 YAML。任何 YAML 处理器都会读取它。在加载端不需要明确支持 JSON。它只是工作。如果您不相信我,请尝试在 YAML 处理器中粘贴一些 JSON(例如 here)。