@Api(value = "后台用户管理")
@RestController
@RequestMapping("bossuser")
public class BossUserController {

    @ApiOperation(value = "测试接口")
    @PostMapping("test")
    public String testUser(@Valid @RequestBody TestUser user) {
        LOG.info(BSModule.COMMON, "测试用户: %s", user.getUserId());
        return "测试成功" + user.getUserId();
    }
}

以上面代码块为例：

• @Api(value = “后台用户管理”) 指定接口模块的名字，放在Controllter上面。
• @ApiOperation(value = “测试接口”) 指定接口名字，放在方法上面
• @Valid 对请求参数进行校验

请求参数类代码：

@Data
@ApiModel(description = "XX请求参数")
public class TestUser {
    @ApiModelProperty(value = "用户id", required = true)
    @NotEmpty(message = "用户id不能为空")
    private String userId;
    @ApiModelProperty(value = "用户名字", required = true)
    @NotEmpty(message = "用户名字不能为空")
    @Size(min = 2, max = 16, message = "用户名长度在2-16之间")
    private String userName;
    @Email(message = "必须符合邮件格式")
    private String email;
    private int age;
}

• @ApiModel(description = “XX请求参数”) 指定参数类的名字
• @ApiModelProperty(value = “用户id”, required = true) 指定属性的名称及是否必填
• @NotEmpty(message = “用户id不能为空”) 自动校验不能为null和""
• @Size 限制长度
• @Email 必须满足邮箱格式

更多文档生成注解可以参考源码：

更多校验注解，可以参考码：