spring boot + swagger3 + redoc使用
要在Spring Boot项目中使用Swagger 3和Redoc,你需要按照以下步骤操作:
- 在
pom.xml
中添加Swagger 3和Redoc的依赖。
<dependencies>
<!-- Swagger 3 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<!-- ReDoc -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.10</version>
</dependency>
</dependencies>
- 配置Swagger 3。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
- 在
application.properties
或application.yml
中配置Redoc。
springdoc:
swagger-ui:
disable-swagger-default-url: true
redoc:
enabled: true
- 启动Spring Boot应用,并访问
http://<host>:<port>/swagger-ui/index.html
。
以上步骤将会在Spring Boot应用中集成Swagger 3和Redoc,并通过默认的URL提供API文档。如果你需要自定义Swagger配置或Redoc的URL,可以在SwaggerConfig
类中进一步设置。
评论已关闭