spring boot 如何集成knife4j-swagger
时间: 2023-09-08 21:13:46 浏览: 169
spring boot 集成swagger+knife4j,集成mybatis-plus和代码生成器
5星 · 资源好评率100%
要在Spring Boot中集成knife4j-swagger,可以按照以下步骤进行操作:
1.添加依赖
在 `pom.xml` 文件中添加以下依赖:
```
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
2.配置Knife4j
在 `application.yml` 或 `application.properties` 文件中添加以下配置:
```
# Swagger配置
swagger:
title: API接口文档
description: API接口文档
version: 1.0.0
license: Apache License 2.0
license-url: http://www.apache.org/licenses/LICENSE-2.0.html
contact-name: xxx
contact-url: xxx
contact-email: xxx
```
3.编写API接口
在Controller类中添加API接口,并且在方法上添加Swagger相关注解。比如:
```
@RestController
@Api(tags = "用户管理")
@RequestMapping("/user")
public class UserController {
@ApiOperation(value = "获取用户列表", notes = "获取所有用户的列表")
@GetMapping("/list")
public List<User> list() {
// 返回用户列表
}
@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
@PostMapping("/create")
public void create(@RequestBody User user) {
// 创建用户
}
}
```
4.启动应用程序
在启动应用程序后,访问 `http://localhost:port/doc.html` 即可查看API文档。
以上就是在Spring Boot中集成knife4j-swagger的步骤。
阅读全文