@Api:用在请求类上,标识对类说明

tags:说明类的作用,参数是个数组,可以填写多个
value:UI上不显示。所有不用配置
description:用户基本信息操作\

@ApiOperation:用于方法,标识一个http请求访问该方法的操作

value:方法的用途和作用
notes:方法注意事项和备注
tags:方法的作用,参数是数组,可以填写多个 前两个常用

@ApiModelProperty:用在属性上,描述实体类的属性

value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选

@ApiImplicitParams:用在请求的方法上,包含多@ApiImplicitParam

@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

@ApiResponse:用在请求的方法上,表示不同的响应

code="404" 表示响应码(int型),可自定义 message="状态码对应的响应信息"

@ApiIgnore():用于类或者方法上,不被显示在页面上

@Profile({"dev", "test"}):用于配置类上,表示只对开发和测试环境有用

04-02 09:40