spring boot集成Knife4j
warning:
这篇文章距离上次修改已过216天,其中的内容可能已经有所变动。
Spring Boot 集成 Knife4j 主要涉及到以下几个步骤:
- 在项目的
pom.xml
文件中添加 Knife4j 的依赖。 - 配置 Swagger 相关的配置类。
- 启动 Spring Boot 应用,并通过 Swagger 提供的 UI 访问文档。
以下是集成 Knife4j 的示例代码:
1. 添加 Maven 依赖
<!-- Swagger 2.X 核心库 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- Swagger UI 页面 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- Knife4j 集成 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.4</version>
</dependency>
2. 配置 Swagger
创建一个配置类,例如 SwaggerConfig.java
:
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.yourpackage"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Your API Title")
.description("Your API Description")
.version("1.0")
.build();
}
}
3. 访问 Knife4j 文档
启动 Spring Boot 应用后,可以通过访问 http://<host>:<port>/doc.html
来查看集成的 Knife4j 文档。
请确保 <host>
和 <port>
替换为实际的服务器地址和端口号。如果你的 Spring Boot 应用使用的是默认端口 8080,并且运行在本地,那么你可以通过 http://localhost:8080/doc.html
来访问 Knife4j 文档页面。
评论已关闭