SpringBoot整合knife4j步骤
时间: 2024-09-29 15:15:18 浏览: 56
Spring Boot 整合 Knife4J,一个用于快速生成API文档的工具,可以提供详细的RESTful API文档。以下是简单的集成步骤:
1. **添加依赖**:首先在你的`pom.xml`文件中添加Knife4J的Maven依赖:
```xml
<dependency>
<groupId>com.github.rvesse</groupId>
<artifactId>knife4j</artifactId>
<version>最新版本号</version>
</dependency>
```
请替换`最新版本号`为实际发布的版本。
2. **启用注解扫描**:为了自动检测带有注解的API,需要在`Application`类上添加`@EnableSwagger2WebMvc`注解,或者如果你使用的是Knife4J 2.x以上版本,可以使用`@.EnableDocumentation注解`:
```java
@SpringBootApplication
@EnableSwagger2WebMvc 或 @EnableDocumentation
public class Application {
//...
}
```
3. **配置信息**:在`application.properties`或`application.yml`中,设置 Knife4J 的相关路径和标题等信息:
```properties
swagger.doc.path=api-docs # API 文档的URL前缀,默认是/docs
knife4j.swagger.title=Your App Name # API 文档的标题
```
4. **创建Controller并添加注解**:创建控制器并在方法上使用`@ApiOperation`、`@ApiParam`等注解来描述API:
```java
@RestController
@RequestMapping("/api")
@Api(value = "用户管理", description = "用户相关的操作")
public class UserController {
@GetMapping("/{id}")
@ApiOperation("获取用户")
public User getUser(@PathVariable Long id) {
//...
}
}
```
5. **运行应用**:启动Spring Boot应用,访问`http://localhost:8080/swagger-ui.html`或配置好的文档地址,即可查看生成的API文档。
阅读全文