API数据格式&异常规范

API接口响应数据格式

{
  "code": "0",
  "msg" : "ok",
  "data": "{}"
}

• code值说明
  • "0"：表示请求成功，其余值都为失败
  • "-1": 表示请求失败，其余值由业务定义。
• msg说明
  • 统一后台组织
• data说明

  • 如果data为集合类型，空值的时候采用空集合

  • 数据状态位采用数字类型，其余统一采用字符串类型

     @JsonSerialize(using = ToStringSerializer.class)
     private Long id;
    
    

分页数据格式

{
  "code": "0",
  "msg" : "ok",
  "data": {
  	"total":"10",
  	"list" : [{},{}]
	}
}

参数形式

• page=1&size=10

• sort=s1_desc;s2_asc

请求方式

• 目前约定只使用GET/POST请求
  • GET
    • /users?id=xxx&name=xxxx
  • POST
    • /users + requestBody

全局异常设计处理

• 系统出现异常HTTP响应状态：200
• 业务系统所有异常继承BizException