Easy Frame

在线文档

基于 Swagger 开发，详细文档可查看 Swagger

  • Api Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源
@Api(value = "名称", produces = "application/json")
  • ApiOperation 用在方法上，说明方法的作用，每一个url资源的定义,使用方式：
@ApiOperation(value = "在线用户", notes = "管理在线用户")
  • ApiModel 描述一个Model的信息
@ApiModel(value="User对象",description="用户对象User")
public class SysUser implements Serializable{
    @ApiModelProperty(value="用户名",name="username",example="admin")
    private String username;
}
  • ApiModelProperty 描述一个model的属性
@ApiModelProperty(value="用户名",name="username",example="admin")
  • ApiParam ApiParam请求属性,使用方式：也可使用在请求对象上
@ApiParam(value = "用户名", required = true) @RequestParam("username") String username
  • ApiResponses 响应集配置 @ApiResponses(value = { @ApiResponse(code = 200, message = "请求成功"), @ApiResponse(code = 500, message = "请求失败") })
  • ApiResponse 响应配置
@ApiResponse(code = "200",message = "请求成功")
  • ResponseHeader 响应头设置
@ResponseHeader(name="head1",description="response head conf")
  • ApiImplicitParams 用在方法上包含一组参数说明
@ApiImplicitParams(value = {
    @ApiImplicitParam(
        name = "Authorization",
        value = "用户Token",
        dataType = "string",
        paramType = "header",
        example = "Bearer 0b79bab50daca910b000d4f1a2b675d604257e42",
        required = true
})

← 系统设置 →