带有webflux的Springdoc openapi:显示自定义json/yml文件，而不是生成的文件

Question

我有一个简单的服务描述文件open-api.json:

{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI definition",
"version": "v0"
},
"paths": {
"/agents/{id}/plugins": {
"post": {
"tags": [
"api-controller"
],
...
},
"components": {}
}

我在我的Spring webflux项目中使用了springdoc openapi webflux ui：

<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
<version>1.4.0</version>
</dependency>

是否可以显示现有文件而不是生成的文件？任何帮助，谢谢！

Answer 1

如果您的文件包含OpenAPI 3格式的OpenAPI文档。然后简单地声明：(文件名可以是任何你想要的，从你的声明一致的那一刻起(

springdoc.swagger-ui.url=/open-api.json

然后文件open-api.json，应该位于：src/main/resources/static

不需要额外的配置。

属性springdoc.swager-ui.configUrl可以用于这里讨论的不同用途，因为其结构不同于

• https://github.com/springdoc/springdoc-openapi/issues/686

Answer 2

好的，这就是您需要的。

1. 在src/main/resources目录中，创建一个名为static的目录。在那个地方你的openapi.json文件。(注意-json文件的名称可以是任何东西([这是一个示例开放api规范json文件]
2. 在应用程序yaml中添加此属性：

springdoc:
swagger-ui:
configUrl: /open-api.json

然后启动你的应用程序并点击URLhttp://localhost:8080/swagger-ui.html

请注意，如果存在弹簧安全性，则需要额外的配置