用java写一个用knife4j-openapi3-spring-boot-starter实现接口文档的完整例子
时间: 2024-03-20 19:40:26 浏览: 93
基于springboot+jpa实现java后台api接口,点餐系统.zip
好的,以下是一个使用knife4j-openapi3-spring-boot-starter实现接口文档的完整例子:
1. 首先,需要在pom.xml文件中添加knife4j-openapi3-spring-boot-starter依赖:
```
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
```
2. 在Spring Boot的启动类上添加@EnableKnife4j注解,开启Knife4j的支持:
```
@SpringBootApplication
@EnableKnife4j
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 编写一个Controller类,并在类上添加@Api注解,指定接口文档的基本信息:
```
@RestController
@Api(tags = "示例接口")
public class ExampleController {
@GetMapping("/hello/{name}")
@ApiOperation(value = "Hello接口")
public String hello(@PathVariable String name) {
return "Hello, " + name + "!";
}
}
```
4. 启动应用程序,访问http://localhost:8080/doc.html即可查看接口文档。
通过以上步骤,我们就可以使用knife4j-openapi3-spring-boot-starter实现接口文档了。当然,我们还可以通过配置文件对接口文档进行更多的自定义设置,例如:
```
# application.yml
knife4j:
swagger-ui:
title: "接口文档"
deepLinking: true
```
以上配置会将接口文档的标题设置为“接口文档”,同时开启深度链接功能。
阅读全文