springboot集成swagger3与knife4j的详细代码
作者:卑微小钟 时间:2023-11-27 18:22:58
springboot集成swagger3
swagger3的springboot启动器jar包
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
注意:当前SpringBoot版本为2.5.6,Swagger3.0目前无法完全兼容SpringBoot2.6.x!
编写TestController代码
@RestController
@RequestMapping("test")
public class TestController {
@GetMapping
public Map<String, Object> get(@RequestParam String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
@PostMapping
public Map<String, Object> post() {
Map<String, Object> r = new HashMap<>(1);
r.put("code", 200);
return r;
}
@PutMapping
public Map<String, Object> put(String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
@DeleteMapping
public Map<String, Object> delete(String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
}
创建Swagger3Configuration
@Configuration
@EnableOpenApi
public class SwaggerConfig {
private static final String VERSION = "0.0.1";
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.groupName("分组名称")
.apiInfo(apiInfo())
.select()
//要扫描的包
.apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 设置标题
.title("文档标题")
//联系人
.contact(contact())
//描述
.description("xxx文档")
//服务
.termsOfServiceUrl("https://spring.io/")
//许可证
.license("Apache 2.0")
.licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
.version(VERSION)
.build();
}
private Contact contact (){
return new Contact("SpringBoot", "https://spring.io/", "email");
}
}
运行演示
访问网址:http://127.0.0.1:8081/swagger-ui/index.html
对接口进行注解
swagger中常用的注解
注解 | 作用 | 使用位置 |
---|---|---|
@Api | 表示对类的说明常用参数 | 类 |
@ApiOperation | 说明方法的用途 | 方法 |
@ApiImplicitParams | 里面可以包含多个@ApiImplicitParam | 方法 |
@ApiImplicitParam | 描述参数的用途 | 方法 |
@ApiModel | 表示一个数据类的信息 | 类 |
@ApiModelProperty | 描述数据类的属性 | 属性 |
@ApiIgnore | 忽略某个字段使之不显示在文档中 | 属性 |
接口基本使用
1.新建一个用户实体类
@ApiModel("用户")
@Data
public class User {
@ApiModelProperty("用户名")
private String username;
@ApiModelProperty("密码")
private String password;
}
2.给TestController添加注解
@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestController {
@ApiOperation("get请求")
@GetMapping
@ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class)
public Map<String, Object> get(@RequestParam String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
@ApiOperation("post请求")
@PostMapping
public Map<String, Object> post(@RequestBody User user) {
Map<String, Object> r = new HashMap<>(1);
r.put("code", 200);
return r;
}
@ApiOperation("put请求")
@PutMapping
@ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class)
public Map<String, Object> put(String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
@ApiOperation("delete请求")
@DeleteMapping
@ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class)
public Map<String, Object> delete(String id) {
Map<String, Object> r = new HashMap<>(1);
r.put("id", id);
return r;
}
}
运行结果
集成更好的UI-knife4j
maven
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-micro-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
启动器
在SwaggerConfig类上添加**@EnableKnife4j**
@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig
访问网站:http://127.0.0.1:8080/doc.html#/home
来源:https://blog.csdn.net/zhongjianboy/article/details/126366785
标签:springboot,集成,swagger3,knife4j
0
投稿
猜你喜欢
Java 使用Socket正确读取数据姿势
2023-09-16 12:13:43
Mybatis-Plus 新增获取自增列id方式
2021-10-22 17:06:38
Java数据结构之单链表详解
2023-11-04 17:02:20
C#动态生成DropDownList执行失败原因分析
2023-08-30 22:37:28
Flutter开发setState能否在build中直接调用详解
2022-05-17 14:55:27
C#语言主要语言区域
2021-10-05 13:58:38
C++二分查找(折半查找)算法实例详解
2021-12-21 04:05:55
OpenGL绘制三次Bezier曲线
2022-04-23 18:18:14
android 判断横竖屏问题的详解
2022-07-28 08:37:13
java hasNextInt判断是否为数字的方法
2023-05-17 01:51:12
ios百度地图的使用(普通定位、反地理编码)
2023-07-03 15:26:17
Android最简单的限制输入方法(只包含数字、字母和符号)
2022-01-22 00:15:45
C#泛型集合类System.Collections.Generic
2023-02-24 19:21:18
使用String类型小数值转换为Long类型
2023-04-14 10:34:56
Android ActionBarActivity设置全屏无标题实现方法总结
2023-09-09 10:44:57
Java开发利器之Guava Cache的使用教程
2022-03-20 19:22:02
JPA 加锁机制及@Version版本控制方式
2022-10-06 10:57:58
VSCode中开发JavaWeb项目的详细过程(Maven+Tomcat+热部署)
2022-10-18 14:42:10
Android自定义带水滴的进度条样式(带渐变色效果)
2023-03-02 06:45:02
IDEA高效使用设置指南
2023-10-30 01:39:37