springboot 整合 knife4j-openapi3
Spring Boot整合Knife4j(OpenAPI 3)主要涉及以下几个步骤:
- 在
pom.xml
中添加Knife4j的依赖。 - 配置Swagger。
- 启动Spring Boot应用,并通过Swagger UI或Knife4j的文档管理页面进行访问。
以下是一个简化的例子:
- 添加依赖(以Maven为例):
<!-- Swagger 3.0 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<!-- Knife4j 3.x -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
- 配置Swagger:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("示例API文档")
.description("这是一个示例API文档")
.version("1.0")
.build();
}
}
- 启动Spring Boot应用,并访问
http://<host>:<port>/doc.html
或http://<host>:<port>/swagger-ui/index.html
。
确保你的Spring Boot应用已经配置了对应的端口和上下文路径。Knife4j的文档管理页面通常是/doc.html
。
以上代码仅为示例,具体实现时需要根据项目的实际情况进行调整,比如配置API的扫描路径、添加安全认证等。
评论已关闭