spingboot整合knif4j
时间: 2023-08-29 13:05:40 浏览: 57
Spring Boot整合Knife4j可以快速生成API接口文档,可以让前后端更好的协作,提高开发效率。下面是整合步骤:
1. 引入依赖
在pom.xml文件中添加Knife4j的依赖:
```
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
```
2. 配置Swagger
在Spring Boot启动类上添加@EnableSwagger2注解开启Swagger,示例代码如下:
```
@SpringBootApplication
@EnableSwagger2
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
```
3. 配置Knife4j
在application.properties文件中配置Knife4j的相关属性,示例代码如下:
```
# 设置Knife4j文档页面的标题
spring.application.name=Demo
# 配置Knife4j的访问路径
springfox.documentation.swagger.v2.path=/api-docs
# 配置Knife4j的UI页面访问路径
knife4j.swagger-ui.path=/doc.html
```
4. 编写API文档
在Controller类上使用Swagger注解编写API文档,示例代码如下:
```
@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController {
@ApiOperation(value = "获取用户列表", notes = "获取所有用户列表")
@GetMapping("/")
public List<User> list() {
// ...
}
@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
@PostMapping("/")
public String create(@RequestBody User user) {
// ...
}
@ApiOperation(value = "更新用户", notes = "根据User对象更新用户")
@PutMapping("/")
public String update(@RequestBody User user) {
// ...
}
@ApiOperation(value = "删除用户", notes = "根据用户ID删除用户")
@DeleteMapping("/{id}")
public String delete(@PathVariable Long id) {
// ...
}
}
```
5. 查看API文档
启动Spring Boot应用程序后,访问http://localhost:8080/doc.html即可查看API文档页面。
以上就是Spring Boot整合Knife4j的步骤,希望对你有所帮助。