Swgger3 接入
接入
引入依赖
引用 Knife4j 的 starter
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.4.0</version>
</dependency>
修改配置
springdoc:
swagger-ui:
path: /swagger-ui.html
tags-sorter: alpha
operations-sorter: alpha
api-docs:
path: /v3/api-docs
group-configs:
- group: 'default'
paths-to-match: '/**'
packages-to-scan: com.ftl.xtrack
# knife4j的增强配置,不需要增强可以不配
knife4j:
enable: false
setting:
language: zh_cn
使用示例
接口示例
@RestController
@Tag(name = "用户 API", description = "用户相关接口")
public class UserController {
@Operation(summary = "普通body请求", description = "普通body请求")
@PostMapping("/body")
public ResponseEntity<User> body(@RequestBody User user) {
return ResponseEntity.ok(user);
}
@Operation(summary = "普通body请求+Param+Header+Path")
@Parameters({
@Parameter(name = "id", description = "文件id", in = ParameterIn.PATH),
@Parameter(name = "token", description = "请求token", required = true, in = ParameterIn.HEADER),
@Parameter(name = "name", description = "文件名称", required = true, in = ParameterIn.QUERY)
})
@PostMapping("/bodyParamHeaderPath/{id}")
public ResponseEntity<User> bodyParamHeaderPath(
@PathVariable("id") String id,
@RequestHeader("token") String token,
@RequestParam("name") String name,
@RequestBody User user) {
user.setName(user.getName() + ",receiveName:" + name + ",token:" + token + ",pathID:" + id);
return ResponseEntity.ok(user);
}
}
实体示例
@Getter
@Setter
@Schema(name = "User ", description = "用户信息实体")
public class User {
@Schema(description = "姓名", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三" )
private String name;
@Schema(description = "年龄", requiredMode = Schema.RequiredMode.AUTO, example = "20")
private Integer age;
@Schema(description = "年龄", requiredMode = Schema.RequiredMode.NOT_REQUIRED, hidden = true)
private LocalDateTime createdAt;
}
本文作者:booleandev
本文链接:https://www.cnblogs.com/booleandev/p/18413409/swgger3-access-z1ijs9w
版权声明:本作品采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步