SpringBoot3中Swagger整合knife4j和springdoc的配置说明
在Spring Boot 3中,你可以选择使用Swagger来记录REST APIs,也可以选择使用Knife4j,它是Swagger的一个增强解决方案,或者使用SpringDoc,这是另一种API文档生成工具。
以下是整合这三种工具的基本配置示例:
Swagger (使用springfox)
- 添加依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
- 配置Swagger:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
访问地址:http://localhost:8080/swagger-ui.html
Knife4j (基于Swagger)
- 添加依赖:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
- 配置Knife4j (通常不需要额外配置):
访问地址:http://localhost:8080/doc.html
SpringDoc
- 添加依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.10</version>
</dependency>
- 配置SpringDoc:
@Configuration
public class SpringDocConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info().title("SpringDoc API")
.description("This is a sample SpringDoc API")
.version("0.0.1-SNAPSHOT"));
}
}
访问地址:http://localhost:8080/swagger-ui/index.html
请注意,这些配置示例可能需要根据你的具体需求进行调整。每个工具都有其特点,你可以根据项目需求和个人喜好选择合适的工具。
评论已关闭