如何使用knife4j
时间: 2024-02-21 11:24:47 浏览: 82
使用 `knife4j` 可以为 Swagger 生成的 API 文档增加一些额外的功能,例如页面美化、接口测试等。下面是使用 `knife4j` 的简单步骤:
1. 在 `pom.xml` 文件中添加 `knife4j-spring-boot-starter` 的依赖项:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
```
2. 在 Spring Boot 的启动类上添加 `@EnableKnife4j` 注解:
```java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
@SpringBootApplication
@EnableSwagger2
@EnableSwagger2WebMvc
@EnableKnife4j
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 在 `application.yml` 或 `application.properties` 中配置 `knife4j`:
```yaml
# 配置 knife4j
knife4j:
title: Knife4j API Doc
description: Knife4j API Doc
version: 1.0.0
contact:
name: Contact Name
url: https://www.example.com
email: contact@example.com
license:
name: Apache License 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
```
4. 访问 Swagger 文档页面,此时已经增加了 `knife4j` 的功能。例如:
```
http://localhost:8080/swagger-ui.html
```
`knife4j` 还提供了丰富的配置选项,例如页面主题、接口文档展示方式等,您可以根据需要进行配置。
阅读全文