Swagger -> SpringDoc
官網地址:https://springdoc.org/
是基於OpenAPI 3.0 規範構建的集成 Swagger UI 和 ReDoc 文檔生成工具,可自動注入OpenAPI規範的JSON描述文件,支持OAUTH2、JWT等認證機制。推薦 Spring Boot 2.4 及以上版本使用springdoc-openapi-ui
集成Swagger 3.x,Spring Boot 2.3及以下版本使用springfox-boot-starter
集成Swagger 2.x,Spring Boot 3使用springdoc-openapi-starter-webmvc-ui
引入。
pom
<!--spring boot >=2.4 -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.7.0</version>
</dependency>
訪問
啓動項目瀏覽/swagger-ui.html
即可看到效果,默認會列出所有Controller及方法。
配置
springdoc:
api-docs:
enabled: true
path: '/docs'
swagger-ui:
path: ''