swagger常用注解汇总
swagger中常用的注解及其使用位置如下:
注解 | 作用 | 使用位置 |
---|---|---|
@Api | 表示对类的说明常用参数 | 类上面 |
@ApiOperation | 说明方法的用途、作用 | 方法上面 |
@ApiModel | 表示一个返回响应数据的信息 | 响应类 |
@ApiModelProperty | 描述响应类的属性 | 属性 |
@ApiIgnore | 忽略某个字段使之不显示在文档中 | 属性 |
@Api:用在请求的类上,表示对类的说明常用参数
参数 | 描述 |
---|---|
tags | 说明该类的作用,非空时将覆盖value的值 |
value | 描述类的作用 |
description | 对api资源的描述,在1.5版本后不再支持 |
basePath | 基本路径可以不配置,在1.5版本后不再支持 |
position | 如果配置多个Api 想改变显示的顺序位置,在1.5版本后不再支持 |
produces | 设置MIME类型列表(output),例:“application/json, application/xml”,默认为空 |
authorizations | 获取授权列表(安全声明),如果未设置,则返回一个空的授权值 |
hidden | 默认为false, 配置为true 将在文档中隐藏 |
代码示例:
@Api(tags="登录请求")
@Controller
@RequestMapping(value="/highPregnant")
public class LoginController {}
@ApiOperation:用在请求的方法上,说明方法的用途、作用
参数 | 描述 |
---|---|
value | 说明方法的用途、作用 |
notes | 方法的备注说明 |
tags | 操作标签,非空时将覆盖value的值 |
response | 响应类型(即返回对象) |
responseContainer | 声明包装的响应容器(返回对象类型)。有效值为 “List”, “Set” or “Map”。 |
responseReference | 指定对响应类型的引用。将覆盖任何指定的response()类 |
httpMethod | 指定HTTP方法,“GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “OPTIONS” and “PATCH” |
responseHeaders | 响应头列表 |
code | 响应的HTTP状态代码。默认 200 |
hidden | 默认为false, 配置为true 将在文档中隐藏 |
代码示例:
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){}
@ApiModel:用于响应类上,表示一个返回响应数据的信息
示例代码:
@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{private static final long serialVersionUID = 1L;
/*** 用户名*/@ApiModelProperty(value="用户名")private String account;/*** 密码*/@ApiModelProperty(value="密码")private String password;}
@ApiModelProperty:用在属性上,描述响应类的属性
参数 | 描述 |
---|---|
value | 此属性的简要说明。 |
name | 允许覆盖属性名称 |
allowableValues | 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值 |
access | 允许从API文档中过滤属性。 |
notes | 目前尚未使用。 |
dataType | 参数的数据类型。可以是类名或者参数名,会覆盖类的属性名称。 |
required | 参数是否必传,默认为false |
position | 允许在类中对属性进行排序。默认为0 |
hidden | 允许在Swagger模型定义中隐藏该属性。 |
example | 属性的示例。 |
readOnly | 将属性设置为只读 |
reference | 指定对相应类型定义的引用,覆盖指定的任何参数值 |
代码示例:
@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{private static final long serialVersionUID = 1L;/*** 用户名*/@ApiModelProperty(value="用户名")private String account;/*** 密码*/@ApiModelProperty(value="密码")private String password;}
@ApiIgnore 忽略某个属性,使之不显示在swagger文档中显示
@GetMapping(value ="page")
@ApiOperation(value ="分页查询登录⽇志")
public Result page(@ApiIgnore LogVo vo){return null;
}
swagger常用注解汇总相关推荐
- Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger常用注解说明
前言 受新型冠状病毒的影响,在家像猪一样不是睡就是吃,闲着就学着用下Swagger和YApi,特将这几天的学习成果写成了这系列的文章,希望能对大家有所帮助.武汉加油,中国加油! Spring Boot ...
- 近100个Spring/SpringBoot常用注解汇总!
作者 | Guide 来源 | JavaGuide(微信公众号) 毫不夸张地说,这篇文章介绍的 Spring/SpringBoot 常用注解基本已经涵盖你工作中遇到的大部分常用的场景.对于每一个注解我 ...
- Spring常用注解汇总
使用注解之前要开启自动扫描功能 其中base-package为需要扫描的包(含子包). 1 <context:component-scan base-package="cn.test& ...
- java开发常用注解汇总
lombok整理 @Data 注解在类上:提供类所有属性的 getting 和 setting 方法,此外还提供了equals.canEqual.hashCode.toString 方法 @Sette ...
- java常用注解汇总_Spring常用注解汇总
概述 注释配置相对于 XML 配置具有很多的优势: 它可以充分利用 Java 的反射机制获取类结构信息,这些信息可以有效减少配置的工作.如使用 JPA 注释配置 ORM 映射时,我们就不需要指定 PO ...
- spring 常用注解汇总
jar包:common-annotations.jar 命名空间:引入context 的 Schema命名空间 在配置文件中添加context:annotation-config标签 配置扫描注解:& ...
- Spring MVC常用注解汇总
@Controller @Controller注解在类上,表明这个类是Spring MVC里的Controller,将其声明为Spring的一个Bean,Dispatch Servlet会自动扫描注解 ...
- springmvc整合swagger 与 常用注解说明
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使 ...
- Spring系列之Spring常用注解总结
参看博客:https://www.cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺 ...
- Spring常用注解总结
传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 1.如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml文 ...
最新文章
- 顺序表-给定的顺序表L中删除元素值在x到y(x<=y)之间的所有的元素
- python 示例_带有示例的Python File write()方法
- Python的bool类型
- 蒙特卡洛方法_【每日一题56】蒙特卡洛方法 用试验所得的频率估计事件发生概率...
- Python统计Excel文件中超市营业额明细数据
- 求职干货:再也不怕面试官问斐波那契数列了!
- tinyint占几个字节_随笔几个小问题
- 手机页面操作栏的创建及WebFont的使用
- ajax请求完之前的loading加载
- 等到小牛电动车出N2再买的原因
- 在 Windows 容器中使用 gMSA
- nodewebkitV0.21.6版本的学习
- cx oracle 中文 u,cx_Oracle 中文乱码
- 无人机项目跟踪记录五十八--原理图控制部分分析
- android 色彩搭配,设计学堂:关于APP配色的一些常用色彩搭配技巧
- Matlab指数函数e最小二乘法,最小二乘法拟合指数函数(Matlab编程),着急,
- Ambari-Agent心跳丢失:Failed to connect to https://xx.xx.xx:8440/ca due to
- CUDA进阶资料专题(一)pinned memory 和 unified memory
- 代码精进之路-读后感
- ACM第一次练习—1000A