文档章节

Swagger2常用注解说明

Ryan-瑞恩
 Ryan-瑞恩
发布于 06/20 10:41
字数 1697
阅读 12
收藏 0

    这里只讲述@Api、@ApiOperation、@ApiImplicitParams、@ApiImplicitParam、@ApiParam、@ApiModel、@ApiModelProperty、ApiResponses、@ApiResponse这几个常用的。

 

一、@Api

用在请求的类上,表示对类的说明

常用参数:

tags="说明该类的作用,非空时将覆盖value的值"
value="描述类的作用"

其他参数:

description           对api资源的描述,在1.5版本后不再支持
basePath              基本路径可以不配置,在1.5版本后不再支持
position              如果配置多个Api 想改变显示的顺序位置,在1.5版本后不再支持
produces              设置MIME类型列表(output),例:"application/json, application/xml",默认为空
consumes              设置MIME类型列表(input),例:"application/json, application/xml",默认为空
protocols             设置特定协议,例:http, https, ws, wss。
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"
position            如果配置多个Api 想改变显示的顺序位置,在1.5版本后不再支持
nickname         第三方工具唯一标识,默认为空
produces            设置MIME类型列表(output),例:"application/json, application/xml",默认为空
consumes            设置MIME类型列表(input),例:"application/json, application/xml",默认为空
protocols           设置特定协议,例:http, https, ws, wss。
authorizations      获取授权列表(安全声明),如果未设置,则返回一个空的授权值。
hidden              默认为false, 配置为true 将在文档中隐藏
responseHeaders       响应头列表
code            响应的HTTP状态代码。默认 200
extensions       扩展属性列表数组

示例:

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account, @RequestParam(value = "pass", required = false) String password){}

 

三、@ApiImplicitParams

用在请求的方法上,表示一组参数说明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

常用参数:

name:参数名,参数名称可以覆盖方法参数名称,路径参数必须与方法参数一致
value:参数的汉字说明、解释
required:参数是否必须传,默认为false [路径参数必填]
paramType:参数放在哪个地方
    · header --> 请求参数的获取:@RequestHeader
    · query --> 请求参数的获取:@RequestParam
    · path(用于restful接口)--> 请求参数的获取:@PathVariable
    · body(不常用)
    · form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值

其他参数:

allowableValues    限制参数的可接受值。1.以逗号分隔的列表   2、范围值  3、设置最小值/最大值
access             允许从API文档中过滤参数。
allowMultiple      指定参数是否可以通过具有多个事件接受多个值,默认为false
example            单个示例
examples         参数示例。仅适用于BodyParameters

示例:

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
@ApiImplicitParams({
      @ApiImplicitParam(name = "name", value = "用户名", required = false, paramType = "query", dataType = "String"),
      @ApiImplicitParam(name = "pass", value = "密码", required = false, paramType = "query", dataType = "String") 
})
public UserModel login(@RequestParam(value = "name", required = false) String account,
                @RequestParam(value = "pass", required = false) String password){}

 

四、@ApiModel

用在请求的类上,表示对类的说明

用于响应类上,表示一个返回响应数据的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)

@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;

}

 

五、@ApiResponses

用在请求的方法上,表示一组响应

@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息

常用参数:

code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类

 

示例:

@ResponseBody
@PostMapping(value="/update/{id}")
@ApiOperation(value = "修改用户信息",notes = "打开页面并修改指定用户信息")
@ApiResponses({
    @ApiResponse(code=400,message="请求参数没填好"),
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})
public JsonResult update(@PathVariable String id, UserModel model){}

 

六、@ApiParam

用在请求方法中,描述参数信息

常用参数:

name:参数名称,参数名称可以覆盖方法参数名称,路径参数必须与方法参数一致
value:参数的简要说明。
defaultValue:参数默认值
required           属性是否必填,默认为false [路径参数必须填]

其他参数:

allowableValues    限制参数的可接受值。1.以逗号分隔的列表   2、范围值  3、设置最小值/最大值
access             允许从API文档中过滤参数。
allowMultiple      指定参数是否可以通过具有多个事件接受多个值,默认为false
hidden             隐藏参数列表中的参数。
example            单个示例
examples         参数示例。仅适用于BodyParameters

示例:

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@ApiParam(name = "name", value = "用户名", required = false) @RequestParam(value = "name", required = false) String account,@ApiParam(name = "pass", value = "密码", required = false) @RequestParam(value = "pass", required = false) String password){}


或以实体类为参数:

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@ApiParam(name = "model", value = "用户信息Model") UserModel model){}

 

© 著作权归作者所有

Ryan-瑞恩

Ryan-瑞恩

粉丝 154
博文 245
码字总数 189458
作品 0
西安
后端工程师
私信 提问
SpringMVC集成springfox-swagger2构建restful API

在集成springfox-swagger2之前,我也尝试着集成了swagger-springmvc,方式差不多,但是swagger-springmvc相对麻烦一点,因为要把它的静态文件copy到自己的项目中。所以还是用新版本的。 至于...

u014231523
2017/01/13
0
0
SpringBoot集成springfox-swagger2构建restful API

上面文章SpringMVC集成springfox-swagger2构建restful API简单写了如何在springmvc中集成swagger2。这边记录下在springboot中如何集成swagger2。其实使用基本相同。 首先还是引用相关jar包。...

u014231523
2017/01/15
0
0
swagger2常用注解说明

说明: 1.这里使用的版本:springfox-swagger2(2.4)springfox-swagger-ui (2.4) 2.这里是说明常用注解的含义和基本用法(也就是说已经对swagger进行集成完成) 没有集成的请参见 Spring...

u014231523
2017/08/01
0
0
SpringBoot集成swagger2

springboot-swagger2-demo 项目介绍 SpringBoot集成swagger2 使用说明 引入maven依赖 启用swagger2 在Controller上添加注释信息(非必须) 启动访问 swagger常用注解 案例 demo地址:https://...

晨猫
2018/10/04
0
0
spring boot 1.5.4 集成Swagger2构建Restful API(十八)

上一篇博客地址:springboot 1.5.4 整合rabbitMQ(十七) 1 Spring Boot集成Swagger2构建RESTful API文档 1.1 Swagger2简介 Swagger2官网:http://swagger.io/ 由于Spring Boot能够快速开发、...

wyait
2017/11/03
0
0

没有更多内容

加载失败,请刷新页面

加载更多

远程拷贝命令scp

命令scp 用途: secure copy,利用ssl安全复制(远程文件复制程序) 语法: ]# scp [选项] [用户名@ip]源文件 [用户@ip]目标文件 选项: -P port 指定远程主机的ssh端口 ...

迷失De挣扎
27分钟前
2
0
HTTP

作者:蛙课网 链接:https://zhuanlan.zhihu.com/p/70949908 来源:知乎 著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。 HTTP协议简介 HTTP(超文本传输协议)是应用...

元歌
52分钟前
2
0
总结使用tslint的一些代码规范

1.冒号后面,逗号后面要有空格,还有一般if语句大括号前面后面也都要有空格 2.使用for (let i = 0; i < arr.length; i++) {}循环数组报错,使用for (const i of arr) {} for (const i of arr...

大换子
今天
2
0
虚函数

虚函数作用: 基类中可以调用继承类中的函数。(相当于就是允许子类覆盖父类中的函数)

colin_86
今天
2
0
DisplayPort 迎来重大更新,数据带宽性能提高3倍

VESA宣布了他们对DisplayPort接口三年来的第一次重大更新。 与DP 1.4a相比,DisplayPort 2.0提供了三倍于DP 1.4a的数据带宽性能,支持超过8K的分辨率,更高的刷新率和更高分辨率的HDR,以及其...

linux-tao
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部