knife4j-openapi3-spring-boot-starter 使用
时间: 2024-01-24 07:03:30 浏览: 176
spring-boot-starter
knife4j-openapi3-spring-boot-starter是一个用于在Spring Boot项目中集成Knife4j的依赖。它可以帮助我们简化Swagger UI和Swagger Bootstrap UI的添加,并自动生成API文档。
要使用knife4j-openapi3-spring-boot-starter,首先需要在项目的pom.xml文件中添加以下依赖:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
添加完依赖后,我们可以在Spring Boot的配置类上使用`@EnableKnife4j`注解来启用Knife4j:
```java
@Configuration
@EnableKnife4j
public class SwaggerConfig {
// 配置相关的Swagger信息
}
```
接下来,我们可以在API接口的方法上使用Swagger相关的注解来标记接口和参数。例如,使用`@ApiOperation`注解来描述接口的作用,使用`@ApiParam`注解来描述参数的含义。
```java
@RestController
@RequestMapping("/api")
@Api(tags = "示例接口")
public class ExampleController {
@GetMapping("/hello")
@ApiOperation("示例接口")
public String hello(@ApiParam("姓名") @RequestParam String name) {
return "Hello, " + name + "!";
}
}
```
最后,启动Spring Boot应用程序并访问Swagger UI的URL(默认为`/doc.html`),您将看到自动生成的API文档界面,其中包含了您标记的接口和参数信息。
阅读全文