jdk11怎么集成Knife4j
时间: 2023-11-11 10:48:54 浏览: 51
集成Knife4j需要以下步骤:
1. 在pom.xml文件中添加Knife4j的依赖:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
2. 在SpringBoot启动类上添加@EnableKnife4j注解:
```java
@SpringBootApplication
@EnableKnife4j
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 配置Knife4j信息,可以在application.yml或application.properties中添加以下配置:
```yaml
knife4j:
title: Knife4j接口文档
description: Knife4j接口文档
version: 1.0.0
contact:
name: knife4j
url: https://github.com/xiaoymin/Knife4j
email: knife4j@sina.com
```
4. 在Controller类上添加@Api注解,可以在类上添加@Api(tags = "XXX")注解指定标签:
```java
@RestController
@Api(tags = "用户管理")
public class UserController {
@GetMapping("/users")
@ApiOperation(value = "获取用户列表")
public List<User> getUsers() {
// ...
}
// ...
}
```
5. 启动应用后,在浏览器中访问http://localhost:port/doc.html即可查看接口文档。
注意:如果您的应用是一个WebMvc项目,需要在WebMvcConfigurerAdapter实现类中添加以下配置:
```java
@Configuration
public class Knife4jConfiguration extends WebMvcConfigurerAdapter {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
```