Knife4j 注解详谈
Controller层添加注解
@Api:用于类;表示标识这个类是swagger的资源
属性名称 | 数据类型 | 默认值 | 说明 |
value | String | "" | 字段说明 |
tags | String[] | "" | 标签说明 |
description | String | "" | 详情描述 |
basePath |
String | "" | 基本路径可以不配置 |
position | int | "" | 如果配置多个Api 想改变显示的顺序位置 |
produces | String | "" | 提供者 (For example, "application/json, application/xml") |
consumes | String | "" | 消费者(For example, "application/json, application/xml") |
protocols | String | "" | 协议(Possible values: http, https, ws, wss.) |
authorizations | Authorization[] | "" | 高级特性认证时配置 |
hidden | boolean | "" | 配置为true 将在文档中隐藏 |
使用实例:
注解加载在controller类上
常用模型:


1 @Api(tags = "HELLO CONTROLLER 测试功能接口")
2 @RestController
3 public class HelloController {
4
5 }
@ApiResponses:在 Rest 接口上使用,用作返回值的描述
参数
属性名称 | 数据类型 | 默认值 | 说明 |
value | ApiResponse[] | "" | 访问对象 |
ApiResponse参数
属性名称 | 数据类型 | 默认值 | 说明 |
code | String | "" | 响应的HTTP状态码 |
message | String | "" | 响应的信息内容 |
response | Class<?> | "" | 用于描述消息有效负载的可选响应类,对应于响应消息对象的 schema 字段 |
reference | String | "" | 指定对响应类型的引用,指定的应用可以使本地引用,也可以是远程引用,将按原样使用,并将覆盖任何指定的response()类 |
responseHeaders | ResponseHeader[] | "" | 声明包装响应的容器,有效值为List或Set,任何其他值都将被覆盖 |
responseContainer | String | "" | 声明响应的容器,有效值为List,Set,Map,任何其他值都将被忽略 |
examples | Example | "" | 例子 |
使用实例:
注解加载在字段上
常用模型:


1 @ApiResponses(value = {
2 @ApiResponse(code = 200, message = "接口返回成功状态"),
3 @ApiResponse(code = 500, message = "接口返回未知错误,请联系开发人员调试")
4 })
5 @PostMapping("hello")
6 public Results<UserVO> hello(@RequestBody UserVO userVO){
7
8 Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
9 return results;
10 }
@ApiOperation:用在方法上,说明方法的作用,每一个url资源的定义
参数
属性名称 | 数据类型 | 默认值 | 说明 |
value | String | "" | url的路径值 |
notes | String | "" | 文本说明 |
tags | String[] | "" | 如果设置这个值、value的值会被覆盖 |
response | Class<?> | "" | 返回的对象 |
responseContainer | String | "" | 声明响应的容器,有效值为List,Set,Map,任何其他值都将被忽略 |
responseReference | String | "" | 声明包装响应的容器,有效值为List或Set,任何其他值都将被覆盖 |
httpMethod | String | "" | "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH" |
position | int | "" | 如果配置多个Api 想改变显示的顺序位置 |
nickname | String | "" | 昵称 |
produces | String | "" | 提供者 (For example, "application/json, application/xml") |
consumes | String | "" | 消费者(For example, "application/json, application/xml") |
protocols | String | "" | 协议(Possible values: http, https, ws, wss.) |
authorizations | Authorization[] | "" | 高级特性认证时配置 |
hidden | boolean | "" | 隐藏 |
responseHeaders | ResponseHeader[] | "" | 声明包装响应的容器,有效值为List或Set,任何其他值都将被覆盖 |
code | String | "" | http的状态码 默认 200 |
extensions | Extension[] | "" | 扩展属性 |
ignoreJsonView | boolean | "" | 是否忽略显示 |
使用实例:
注解加载在字段上
常用模型:


1 @ApiOperation(value = "Hello 测试接口", notes = "访问此接口,返回hello语句,测试接口")
2 @PostMapping("hello")
3 public Results<UserVO> hello(@RequestBody UserVO userVO){
4
5 Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
6 return results;
7 }
@PathVariable:是获取get方式,url后面参数,进行参数绑定(单个参数或两个以内参数使用)
参数
属性名称 | 数据类型 | 默认值 | 说明 |
value | String | "" | url的路径值 |
name | String | "" | 重写属性名字 |
required | String | "" | 是否必填 |
使用实例:
注解加载在字段上
常用模型:


1 @ApiResponses(value = {
2 @ApiResponse(code = 200, message = "接口返回成功状态"),
3 @ApiResponse(code = 500, message = "接口返回未知错误,请联系开发人员调试")
4 })
5 @ApiOperation(value = "获取用户信息", notes = "访问此接口,返回用户信息")
6 @PostMapping("/getUser/{id}")
7 public String getUser(@PathVariable String id) throws InterruptedException {
8 // 业务...
9 return "";
10 }
@RequestBody :在当前对象获取整个http请求的body里面的所有数据(两个以上参数封装成对象使用)
参数
属性名称 | 数据类型 | 默认值 | 说明 |
required | String | "" | 是否必填 |
使用实例:
注解加载在传入参数对象上
常用模型:


1 @ApiResponses(value = {
2 @ApiResponse(code = 200, message = "接口返回成功状态"),
3 @ApiResponse(code = 500, message = "接口返回未知错误,请联系开发人员调试")
4 })
5 @ApiOperation(value = "Hello 测试接口", notes = "访问此接口,返回hello语句,测试接口")
6 @PostMapping("hello")
7 public Results<UserVO> hello(@RequestBody UserVO userVO){
8 Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
9 return results;
10 }
Knife4j 注解详谈的更多相关文章
- 2022IDEA配置启动lilishop的swagger展示
目录 一.概述 二.基本构建 三.Git 导入编译器 四.模块描述浅析 五.配置文档 1.注释配置文件 2.添加配置 3.暂时关闭权限 4.浏览器测试访问 5.其他需要修改模块 六.参考文献 结语 一 ...
- Knife4j添加lombok及注解初探
一.POM添加 在pom文件里添加包 1 <!-- 添加Lombok插件--> 2 <dependency> 3 <groupId>org.projectlombo ...
- 详谈springboot启动类的@SpringBootApplication注解
前几天我们学会了如何创建springboot项目今天我们说一下他是怎么运行的为什么不需要我们再去编写繁重的配置文件的 @SpringBootApplication 首先我们看一下这个注解,他是用来标注 ...
- Android 编译时注解解析框架
2.注解 说道注解,竟然还有各种分类,得,这记不住,我们从注解的作用来反推其分类,帮助大家记忆,然后举例强化大家的记忆,话说注解的作用: 1.标记一些信息,这么说可能太抽象,那么我说,你见过@Over ...
- Android 打造编译时注解解析框架 这只是一个开始
转载请标明出处:http://blog.csdn.net/lmj623565791/article/details/43452969 ,本文出自:[张鸿洋的博客] 1.概述 记得很久以前,写过几篇博客 ...
- SpringBoot整合knife4j
官网说明及用法: 简介 swagger-bootstrap-ui是springfox-swagger的增强UI实现,为Java开发者在使用Swagger的时候,能拥有一份简洁.强大的接口文档体验 核心 ...
- 给Swagger换一套皮肤 Knife4j集成记录
Swagger有一套经典的UI,但是并不是很好用,之前有看到Knife4j,界面没管.功能完善,因此尝试集成. demo参考示例地址:knife4j-spring-boot-demo Knife4j前 ...
- 3、集成springfox-swagger 3.0.0 + 集成knife4j
集成springfox-swagger 3.0.0 + 集成knife4j 1.基本用法 1.1.导入依赖 <!-- web接口 --> <dependency> <gr ...
- 魔改swagger:knife4j的另外一种打开方式
之前公司使用了swagger作为文档管理工具,原生的swagger-ui非常丑,之后就用了开源项目 萧明 / knife4j 的swagger组件进行了swagger渲染,改造之后界面漂亮多了,操作也 ...
随机推荐
- 今天你花里胡哨了吗 --- 定制属于自己的linux ssh迎宾信息
请开始你的表演 linux-oz6w:~ # cat << 'eof' > /etc/profile.d/ssh-login-info.sh #!/bin/sh # 输出一个图像 e ...
- 聊聊MySQL的加锁规则《死磕MySQL系列 十五》
大家好,我是咔咔 不期速成,日拱一卒 本期来聊聊MySQL的加锁规则,知道这些规则后可以判断SQL语句的加锁范围,同时也可以写出更好的SQL语句,防止幻读问题的产生,在能力范围内最大程度的提升MySQ ...
- 容器化 | 在 KubeSphere 中部署 MySQL 集群
程润科 数据库研发工程师,目前从事 RadonDB MySQL Kubernetes 研发,热衷于研究数据库内核.K8s 相关技术. 张莉梅 高级文档工程师,目前负责数据库产品文档开发.维护和管理工作 ...
- 2. 堪比JMeter的.Net压测工具 - Crank 进阶篇 - 认识yml
目录 堪比JMeter的.Net压测工具 - Crank 入门篇 堪比JMeter的.Net压测工具 - Crank 进阶篇 - 认识yml 堪比JMeter的.Net压测工具 - Crank 进阶篇 ...
- harbor服务器脚本
项目实战,160服务器上安装harbor.mysql等 检查端口 check.sh #!/bin/bash echo -e "\033[31;1;4;5m check mysql... \0 ...
- bugku-Web md5 collision writeup
访问题目链接,得到提示input a,而题目是md5 collision,md5碰撞.所以找一个md5是oe开头的值,get方式传参过去,PAYLOAD http://114.67.246.176:1 ...
- 【windows 操作系统】协程
◆ 协程 由程序员手动切换. 属于线程,是在线程里面跑的,因此协程又称微线程和线程等.由于不用进行线程上下文切换,因此效率会更高. 资源: 拥有自己的栈空间,大小动态调整. 安全性: 拥有自己的寄存器 ...
- bool 类型位逻辑运算符(| & ^)与条件逻辑运算符(|| &&)的区别
bool 类型的运算符 & ^| && || ! 运算符&&和|| 是短路的,这意味着如果左侧表达式的值足以确定结果,则它们将不会评估其右侧表达式. ...
- Vue之获取DOM元素与更新DOM后事件的特殊情况
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...
- c# 读取对象的[公有属性]的名称,类型,值
/// <summary> /// 获取某个对象的[公有属性]的名称,类型,值 /// </summary> /// <typeparam name="T&qu ...