如何使用Openapi配置Swagger

Question

我刚开始使用springdoc openapi。我想能够自定义Swagger的背景颜色，标志等。有办法做到这一点吗？我看到springdoc-openapi-ui包括webjars/swagger-ui，但我不想只运行自定义版本。我更愿意把它作为一个更新，这样它就不会干扰未来的升级

为了进行实验，我尝试将整个swagger ui发行版复制到我的资源目录：resources/swagger-ui。我也试过resources/webjars/swagger-ui。

在我的pom中，我有

<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.6</version>
<exclusions>
<exclusion>
<groupId>org.webjars</groupId>
<artifactId>swagger-ui</artifactId>
</exclusion>
</exclusions>
</dependency>

所以它应该只使用我的本地版本。但我得到了404

GET "/swagger-ui/index.html", parameters={}                                    
Mapped to ResourceHttpRequestHandler [classpath [META-INF/resources/webjars/]] 
Resource not found                                                             
Completed 404 NOT_FOUND                                                        

不确定为什么在swagger-ui/index.html上找不到它

Answer 1

看起来您需要在.properties文件中设置一些变量：

尝试

springdoc.swagger-ui.path=/swagger   <- sets the url path so you can see localhost:8080/swagger/index.html
springdoc.swagger-ui.enabled=true   <- sets the swagger-ui to enabled
springdoc.api-docs.enabled=true   <- sets the springdoc openapi enpoint to enabled

我会在这里寻找你可能需要的其他财产设置，比如在生产中关闭招摇，等等。。。https://springdoc.org/#properties

至于自定义，您将不得不创建自己的.html页面，并禁用默认页面的使用。

springdoc.swagger-ui.path=MyNewHtmlFile.html

我认为这是用于设置自己的.html文件的属性名称。