knife4集成springboot
时间: 2023-06-28 07:05:09 浏览: 79
要将 Knife4 集成到 Spring Boot 中,可以按照以下步骤进行操作:
1. 首先,在 pom.xml 文件中添加 Knife4 的依赖:
```xml
<dependency>
<groupId>com.github.vipcxj</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
2. 在 Spring Boot 的启动类上添加 `@EnableKnife4j` 注解,开启 Knife4j 的自动配置:
```java
@SpringBootApplication
@EnableKnife4j
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
```
3. 在 `application.yml` 或 `application.properties` 文件中添加 Knife4j 的配置项,例如:
```yaml
# Knife4j 配置
knife4j:
swagger-ui:
path: /api-docs
title: Demo API
version: 1.0.0
```
其中,`path` 是 Swagger UI 的访问路径,`title` 是 API 文档的标题,`version` 是 API 文档的版本号。
4. 在控制器类上使用 `@ApiOperation`、`@ApiParam` 等注解添加 API 文档的描述信息,例如:
```java
@RestController
@RequestMapping("/api/demo")
@Api(tags = "Demo API")
public class DemoController {
@GetMapping("/{id}")
@ApiOperation("根据 ID 获取 Demo 对象")
public Demo getById(@PathVariable @ApiParam("ID") Long id) {
// ...
}
// ...
}
```
5. 访问 Swagger UI,即可查看生成的 API 文档了。默认情况下,Swagger UI 的访问地址是 `http://localhost:8080/api-docs`。
阅读全文