当前位置:实例文章 » JAVA Web实例» [文章]springboot 配置Knife4j- Swagger3.0

springboot 配置Knife4j- Swagger3.0

发布人:shili8 发布时间:2025-02-10 18:49 阅读次数:0

**Spring Boot 配置 Knife4j-Swagger3.0**

Knife4j 是一个基于 Spring Boot 的 API 文档工具,类似于 Swagger,但更加轻量级和易用。它可以帮助我们快速生成 API 文档,并且支持 Swagger2.0 和 OpenAPI 规范。

在本文中,我们将一步步地配置 Knife4j-Swagger3.0 在 Spring Boot项目中。

**依赖配置**

首先,我们需要在 `pom.xml` 文件中添加 Knife4j 的依赖:

xml<dependency>
 <groupId>com.github.xiaoymin</groupId>
 <artifactId>knife4j-spring-boot-starter</artifactId>
 <version>3.0.1</version>
</dependency>

**配置 Knife4j**

接下来,我们需要在 `application.properties` 文件中配置 Knife4j:
propertiesspring:
 knife4j:
 enable: true # 是否启用 Knife4j title: API 文档 # API 文档标题 description: API 文档描述 # API 文档描述

**配置 Swagger**

Knife4j 支持 Swagger2.0 和 OpenAPI 规范,我们可以通过以下方式配置 Swagger:
propertiesspring:
 knife4j:
 swagger:
 enable: true # 是否启用 Swagger title: Swagger API 文档 # Swagger API 文档标题 description: Swagger API 文档描述 # Swagger API 文档描述

**配置 OpenAPI**

如果我们需要使用 OpenAPI 规范,我们可以通过以下方式配置:
propertiesspring:
 knife4j:
 openapi:
 enable: true # 是否启用 OpenAPI title: OpenAPI 文档 # OpenAPI 文档标题 description: OpenAPI 文档描述 # OpenAPI 文档描述

**编写 API 接口**

接下来,我们需要编写 API 接口:
java@RestController@RequestMapping("/api")
public class ApiController {
 @GetMapping("/hello")
 public String hello() {
 return "Hello, World!";
 }
}

**Knife4j 配置**

最后,我们需要配置 Knife4j:
java@Configuration@EnableSwagger2public class SwaggerConfig implements WebMvcConfigurer {
 @Bean public Docket docket() {
 return new Docket(DocumentationType.SWAGGER_2)
 .select()
 .apis(RequestHandlerSelectors.any())
 .paths(PathRequest.toAnyRequest().build())
 .build();
 }
}

**Knife4j UI**

最后,我们可以通过以下方式访问 Knife4j UI:
bash />这样我们就完成了 Spring Boot 配置 Knife4j-Swagger3.0 的步骤。

**总结**

在本文中,我们一步步地配置了 Knife4j-Swagger3.0 在 Spring Boot项目中。通过这些步骤,我们可以轻松生成 API 文档,并且支持 Swagger2.0 和 OpenAPI 规范。

**参考资料**

* [Knife4j]( />* [Swagger]( />* [OpenAPI](

其他信息

其他资源

Top