knife4j-openapi3-jakarta-spring-boot-starter 使用范例
时间: 2023-08-27 14:10:10 浏览: 519
你可以参考下面的示例来使用 knife4j-openapi3-jakarta-spring-boot-starter:
1. 在你的 Spring Boot 项目的 pom.xml 文件中添加以下依赖:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.1</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-ui</artifactId>
<version>3.0.1</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-annotations</artifactId>
<version>3.0.1</version>
</dependency>
```
2. 创建一个 API 接口类,使用 Jakarta RESTful Web Services (JAX-RS) 注解来定义接口和参数。例如:
```java
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
@Path("/api")
@Api(tags = "API")
public interface ApiController {
@GET
@Path("/hello")
@Produces("application/json")
@ApiOperation(value = "Say hello", notes = "Returns a greeting message")
String sayHello();
}
```
3. 在你的 Spring Boot 应用类上添加 `@EnableKnife4j` 注解,启用 Knife4j 的自动配置。例如:
```java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
@EnableKnife4j
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
4. 运行你的 Spring Boot 应用,并访问 `http://localhost:8080/doc.html` 来查看生成的 API 文档和接口测试界面。
这就是一个简单的使用 knife4j-openapi3-jakarta-spring-boot-starter 的范例。你可以根据自己的需求进一步定制和配置。希望对你有帮助!
阅读全文