说明

• 首先@ApiOperation注解不是Spring自带的，它是是swagger里的
• 注解@ApiOperation是用来构建Api文档的

作用范围	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

@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response =“接口返回参数类型”, notes = “接口发布说明”

@ApiOperation(value = "发布岗位",httpMethod = "POST",notes = "发布岗位")

@ApiResponse

code - 响应的HTTP状态码

message - 响应的信息内容

@ApilmplicitParams和@ApilmplicitParam

@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")

@ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })

使用流程

从导入依赖到配置文件启用swaggerUI
一文读懂如何使用

token验证配置

swagger启用token验证配置文件

url传参问题

URL传参问题

swagger官网