swagger常用注解

1. @Api()

作用于类，放置于controller的一个类上，标志这个类是swagger资源

@Api(value = "说明", tags = "说明")

 

 

 

2. @ApiOperation()

作用方法上

 

 

 

@ApiOperation(value = "获取当前用户信息", notes = "通过账号、手机、邮箱查找用户信息" )

 

 

3. @ApiParam()

作用于方法，用于参数字段的说明

 

@ApiParam(name = "username", value = "值为 账号、手机、邮箱", required = true)

 

 

 

 

 

 

4. @ApiModel()

用于类，对类进行说明

 

 

 

@ApiModel(value="用户基本信息" , description="用户基本信息。")

 

 

 

 

 

5. @ApiModelProperty()

用于实体类 字段

 

 @ApiModelProperty(value = "用户序号", name = "gtUserId", required = true)

 

 

 

 

 

6. @ApiImplicitParams()

用于方法解释请求参数里边添加@ApiImplicitParam()注解

 

 @ApiOperation(value = "删除", notes = "删除指定gtUserId的用户")
 @ApiImplicitParams({
        @ApiImplicitParam(name = "gtUserId", value = "用户ID", paramType = "path", required = true)
    })
 @PostMapping(value = "/{gtUserId}", method = RequestMethod.DELETE)
 Admin delete(@PathVariable("gtUserId") String gtUserId);