springdoc - 我们可以在 Springdoc 中用 redoc 替换 swagger-ui

Question

我正在尝试用 Springdoc 替换手动维护的 swagger 文件。目前，我们使用ReDoc来渲染文件，因为它们支持discriminator.

swagger-ui有没有一种直接的方法来替换/取代嵌入式ReDoc？

Answer 1

您可以使用以下命令禁用默认的 swagger-ui

springdoc.swagger-ui.enabled=false

请参阅https://springdoc.org/上的“禁用 swagger-ui”部分

之后，您需要做的就是将 ReDoc 放在您的服务器上，并让它指向 OpenAPI 描述，通常位于 /context-path/v3/api-docs请参阅https://github.com/Redocly
上的“部署”部分/redoc

Answer 2

在 springdoc 中，您可以跳过使用 swagger UI 包并使用：

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webmvc-core</artifactId>
    </dependency>

反而。然后，您可以在组件中指向使用 springdoc（默认为 /v3/api-docs）生成的 swagger 模式的位置<redoc />。其余的取决于您托管 Redoc 的方式。在我们的例子中，我们只是向我们的服务/应用程序添加了一个控制器，它提供了 Redoc 文档页面 ( https://github.com/Redocly/redoc#tldr ) 上描述的基本 HTML。