如何在不使用confluence插件的情况下将swagger/openapi yaml文件包含到doctoolchain中并获得类似swagger的输出？

Question

我曾尝试使用https://doctoolchain.github.io/docToolchain/创建包含swagger/openapi yaml文件的HTML或PDF文档。它看起来唯一的输出是成合流，这也需要一个额外的合流插件。这是目前唯一的选择吗？我可以使用docToolchain做其他的asciidoc和图表格式化，我会很高兴包括swagger。我可以发布到confluence，但不能将任何一个swagger插件添加到我们的系统中。

Answer 1

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

关于configuration，您需要在config.groovy中将OpenAPI规范的位置声明为json文件，如下所示：

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生成是我们希望很快实现的功能之一，但不幸的是，目前我们不能给出任何预计值。尽管如此，还是欢迎github项目的PR :)