Spring注释swagger注释@API说明

最新推荐文章于 2024-04-12 06:06:09 发布

zhiFengS

最新推荐文章于 2024-04-12 06:06:09 发布

阅读量2.8k

点赞数

作用范围 API 使用位置

对象属性 @ApiModelProperty 用在参数对象的字段上

协议集描述 @Api 用在Conntroller类上

协议描述 @ApiOperation 用在controller方法上

Response集 @ApiResponses 用在controller方法上

Response @ApiResponse 用在@ApiResponses里面

非对象参数集 @ApilmplicitParams 用在controller方法上

非对象参数描述	@ApiImplicitParam	用在@ApiImplicitParams的方法里边
描述返回对象的意义	@ApiModel	用在返回对象类上

@ApiModelProperty的用法

value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

// 我这个用在实体类的get()方法上了
/**
   * 获取城市编号
   * @return 城市编号
   */
   @ApiModelProperty(value="城市编号",example="058",required=true)
   public String getCode() {
       return code;
   }

   /**
   * 设置城市编号
   * @param code 城市编号
   */
   public void setCode(String code) {
       this.code = code;
   }

   /**
   * 获取城市名称
   * @return 城市名称
   */
   @ApiModelProperty(value="城市名称",example="guangZhou",required=true)
   public String getName() {
       return name;
   }

@Api

value - 字段说明

description - 注释说明这个类

@ApiOperation

value - 字段说明

notes - 注释说明

httpMethod - 说明这个方法被请求的方式

response - 方法的返回值的类型

@ApiResponse

code - 响应的HTTP状态码

message - 响应的信息内容

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性，下面我们把她分成三类进行说明。

1、 value， method；

value：指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；

method：指定请求的method类型， GET、POST、PUT、DELETE等；

@RequestMapping(value="/new", method = RequestMethod.GET)

2、 consumes，produces；

consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")

方法仅处理request Content-Type为“application/json”类型的请求。

@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")

方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型为application/json;

3、 params，headers；

params：指定request中必须包含某些参数值是，才让该方法处理。

headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。

@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")

仅处理请求中包含了名为“myParam”，值为“myValue”的请求；

@RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.test.com/")

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.test.com/”的请求；

@GetMapping是一个组合注解是@RequestMapping(method = RequestMethod.GET)的缩写

@PostMapping是一个组合注解是@RequestMapping(method = RequestMethod.POST)的缩写