3

我尝试使用https://doctoolchain.github.io/docToolchain/创建包含 swagger/openapi yaml 文件的 HTML 或 PDF 文档。看起来唯一的输出是进入 confluence，它还需要一个额外的 confluence 插件。这是目前唯一的选择吗？我可以使用 docToolchain 进行其他 asciidoc 和图表格式设置，我很乐意包含 swagger。我可以发布到 confluence，但无法将任何一个 swagger 插件添加到我们的系统中。

4

1 回答 1

0

除了能够将其发布到 confluence 之外，您还可以生成 HTML 或 PDF 文件。为此，必须正确配置它并执行生成相应输出格式的命令 (generateHTML|generatePDF)。目前，结果将是静态的（没有交互式 Swagger-UI 页面，因此您将无法从生成的输出中发出任何请求）。

关于配置，您需要将 OpenAPI 规范的位置声明为 json 文件config.groovy，例如：

openApi.with {
    specFile = 'src/docs/petstore-v2.0.yaml' 
    infoUrl = 'https://my-api.company.com'
    infoEmail = 'info@company.com'
}

InfoUrl 和 InfoEmail 只是用于 HTML/PDF 标题的元参数。

通过 docToolchain 生成交互式 SwaggerUI 是我们希望尽快实现的功能之一，但不幸的是，我们目前无法提供任何 ETA。尽管如此，欢迎 github 项目的 PR :)

于 2021-08-08T19:33:43.743 回答