springmvc集成knife4j2.0.9
时间: 2023-07-28 09:03:50 浏览: 218
SpringMVC框架集成Knife4j(官网)(源代码)
SpringMVC集成Knife4j 2.0.9的步骤如下:
1. 在项目的`pom.xml`文件中添加Knife4j的依赖:
```
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
```
2. 配置SpringMVC的`WebMvcConfigurer`,并重写`addResourceHandlers`方法,将Knife4j的静态资源目录添加到资源处理器中:
```java
@Configuration
public class Knife4jConfiguration implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
```
3. 在SpringMVC的配置类中添加`@EnableKnife4j`注解,开启Knife4j的自动配置功能:
```java
@Configuration
@EnableKnife4j
public class MvcConfig {
// 配置其他SpringMVC相关的配置
// ...
}
```
4. 在Controller类上使用Knife4j的注解,例如使用`@ApiOperation`注解添加接口文档的描述信息:
```java
@RestController
@Api(tags = "示例接口")
public class SampleController {
@ApiOperation("示例接口")
@GetMapping("/sample")
public String sample() {
return "Hello, Knife4j!";
}
}
```
5. 启动项目后,访问`http://localhost:8080/doc.html`可以看到Knife4j的接口文档页面,其中包含了通过`@ApiOperation`注解添加的接口信息。
以上就是使用SpringMVC集成Knife4j 2.0.9的简要步骤,通过这样的配置,可以方便地为SpringMVC项目添加接口文档功能。注意,这里的步骤仅适用于Knife4j 2.0.9版本,如果有其他版本的需求,请参考相应版本的官方文档。
阅读全文