[Spring]~Swagger常用注解

Swagger常用注解

@Api（swagger类属性设置，注释在类上）

• 使用方式

@Api(tags = "测试类（名称字段）",description = "测试接口（描述字段）",value = "值")
public class TestController 

• 效果
  

@ApiOperation（swagger方法属性设置，注释在方法上）

• 使用方式

	@ApiOperation(tags = "接口标签",value = "测试接口")
    @PostMapping("/test")
    public QYResponse test(){
        QYResponse qyResponse = new QYResponse(0,"success","成功");
        return qyResponse;
    }

• 效果
  

@ApiIgnore（swagger忽略方法，注释在方法上）

• 使用方式

    @ApiOperation("配置文件引用测试")
    @ApiIgnore(value = "忽略")
    @PostMapping("/test3")
    public QYResponse test3() throws IllegalAccessException, InstantiationException {
        Animal animal = Animal.class.newInstance().getDog();
        QYResponse qyResponse = new QYResponse(0,animal.getName(),"成功");
        return qyResponse;
    }

• 效果
  没有test3
  

@ApiModel（参数实体、返回实体信息设置，注释在类上）

• 使用方式

@ApiModel(value = "返回实体",description = "实体描述")
public class QYResponse {

• 效果
  

@ApiModelProperty（参数实体、返回实体字段设置，注释在字段上）

• 使用方式

@ApiModel(value = "返回实体",description = "实体描述")
public class QYResponse {
    @ApiModelProperty(value = "code字段值",name = "code字段名称")
    private int code;
    @ApiModelProperty(value = "msg字段值",name = "msg字段名称")
    private String msg;
}

@Data
@ApiModel(value = "Code参数",description = "描述;用于传递参数")
public class CodeDTO {
    @ApiModelProperty(name = "code字段",value = "描述;code参数字段描述")
    String code;
    @ApiModelProperty(name = "name字段",value = "值是什么")
    String name;
}

• 效果
  

@ApiParam（参数设置，注释在返回参数上）

• 使用方式

    public QYResponse test2(@RequestBody @ApiParam(value = "参数值",name = "参数名称") CodeDTO codeDTO){

• 效果