类上@Api()
tags:说明该类的作用,参数是个数组,可以填多个。
value="该参数没什么意义,在UI界面上不显示,所以不用配置"
description = "用户基本信息操作"
方法上@ApiOperation()
value="方法的用途和作用"
notes="方法的注意事项和备注"
tags:说明该方法的作用,参数是个数组,可以填多个。
格式:tags={"作用1","作用2"}
实体上@ApiModel()
属性上@ApiModelProperty
value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
请求方法上@ApiImplicitParams
包含多@ApiImplicitParam
name="参数ming"
value="参数说明"
dataType="数据类型"
paramType="query" 表示参数放在哪里
· header 请求参数的获取:@RequestHeader
· query 请求参数的获取:@RequestParam
· path(用于restful接口) 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
defaultValue="参数的默认值"
required="true" 表示参数是否必须传
方法的参数字段说明@ApiParam()
name="参数名称"
value="参数的简要说明"
defaultValue="参数默认值"
required="true" 表示属性是否必填,默认为false
方法上响应码响应@ApiResponses
一个@ApiResponses包含多个@ApiResponse
code="404" 表示响应码(int型),可自定义
message="状态码对应的响应信息"
不被显示@ApiIgnore()
环境@Profile({"dev", "test"})