Swagger注解 详解

@Api : 该注解表示类中的方法可以做为接口
tags: " 说明该类的作用，可以在UI界面上看到的注解"
value:" 该参数没什么意义，在UI界面上也看到，所以不需要配置"
@ApiOerarion : 该注解用在请求的方法上，说明方法的用途和作用
value :" 说明方法的用途、作用"
notes: " 方法的备注说明"
@ApiImplcitParams 该注解表示方法可以为一个接口,用在请求的方法上，表示一组参数说明

        “接口地址”“分类”“请求方法”“功能描述”“功能详细说明”“操作ID”

@ApiImplcitParam : 用在 @ApiImplcitParams 内部的parameters={@ApiImplcitParam(namee="",value="" ) ,}

 in : “输入参数类型 ”，可取如下值 
       <li>query - 参数拼接到url中</li>
        <li>body - 参数直接放入请求体中</li>
        <li>path - restful风格的参数传递</li>
        <li>header - 参数放在请求头中</li>
        <li>formData - 参数通过form表单提交</li>
 schema：“包装对象”

@ApiResponses : 用于请求的方法上，表示一组响应。@ApiResponses（value={@ApiResponse(code=1 , message="")}）
@ApiResponse : 描述该响应返回的一系列描述

code: “状态码”
message: “信息” 例如“请求参数输入异常”
response: " 抛出异常的类"
1.

@ApiResponse(code=400,message=“请求参数没填好”),
2.

@ApiResponse(code=404,message=“请求路径没有或页面跳转路不对”)

@ApiModel: 用于响应类上，表示一个返回响应数据的信息。

        （这种一般用在post创建的时候，使用@RequestBody这样的场景，
        请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty : 用在属性上，描述响应类的属性。

@ApiModel(description = “返回响应的数据”)
public class RestMessage implements Serializable {
@ApiModelProperty(value = “是否成功”)
private boolean success=true;
@ApiModelProperty(value = “返回对象”)
private Object data;
@ApiModelProperty(value = “错误编号”)
private Integer errCode;
@ApiModelProperty(value = “错误信息”)
private String message;
}