Swagger笔记之Swagger注解

@TOC

|

Swagger-注解：

api标记，用在类上，说明该类的作用。可以标记一个Controller类做为Swagger文档资源，使用方式

与Controller注解并列使用。 属性配置：

Controller 控制器

@Api

tags 一定要写，不然swagger扫描显示的是类名

@ApiOperation

ApiOperation标记，用在方法上，说明方法的作用，每一个url资源的定义,使用方式：

@ApiOperation("获取用户信息")

与Controller中的方法并列使用，属性配置：

@ApiParam

ApiParam标记，请求属性，使用方式：

public TableDataInfo list(@ApiParam(value = "查询用户列表", required = true)User user)

与Controller中的方法并列使用，属性配置：

@ApiResponse

ApiResponse标记，响应配置，使用方式：

@ApiResponse(code = 400, message = "查询用户失败")

与Controller中的方法并列使用，属性配置：

@ApiResponses

ApiResponses标记，响应集配置，使用方式:

@ApiResponses({ @ApiResponse(code = 400, message = "无效的用户") })

与Controller中的方法并列使用，属性配置：

@ResponseHeader

ResponseHeader标记，响应头设置，使用方法

@ResponseHeader(name="head",description="响应头设计")

与Controller中的方法并列使用，属性配置：

火中取栗

@RestController
@RequestMapping("/msg/im")
@Api(tags = "消息-IM")
public class IMController {

    @ApiOperation("生成用户签名")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "String")
    })
    @GetMapping("/{userId}")
    public R<String> test(@PathVariable("userId") @ApiParam(value = "用户ID", required = true) String userId) {
        return R.ok(IMTencentUtil.genUserSig(userId));
    }
}

VO 返回对象

其中@Null、@NotNull。。等与@Valiated 配合使用

@ApiModel

用在返回对象类上

@ApiModelProperty

用在返回对象的属性上

火中取栗

@ApiModel("testVo")
public class MsgPageVO
{
    /** 消息ID */
    @ApiModelProperty("消息ID")
    private Long msgId;
}

注意：

@Api(tags = “”)写，不然swagger扫描显示的是类名

持续更新中。。。。