Releases: fengwenyi/api-result
Releases · fengwenyi/api-result
v2.6.0
- 【变更】ResponseTemplate 属性 code 类型变由 Integer 变更为 String
- 【变更】IReturnCode 方法 getCode() 返回类型变由 Integer 变更为 String
- 【变更】IReturnCode.Default 中的返回码也做了变更
- 【变更】PageRequestVo 希望被继承，所以只保留 currentPage 和 pageSize
- 【优化】有些方法没有被使用，为避免编辑器警告提示，增加
@SuppressWarnings("all") - 【优化】优化文案描述
v2.5.3
v2.5.2
v2.5.1
v2.5.0
- 【变更】ResultTemplate，code类型改为Integer
- 【变更】ResultTemplate，msg改为message
- 【变更】IReturnCode，getErrCode()改为getCode()
- 【变更】IReturnCode，getMsg()改为getMessage()
- 【变更】IReturnCode，getErrCode()返回类型改为Integer
- 【变更】IReturnCode，成功的返回码改为0
- 【变更】IReturnCode，错误的返回码改为-1
- 【变更】IReturnCode，Default，枚举错误去掉前缀ERROR
- 【变更】ResultTemplate更名为ResponseTemplate
- 【变更】ResultHeader更名为ResponseHeader
- 【删除】ResultTemplate，删除errCode
- 【删除】ResultTemplate，删除errMsg
- 【删除】IReturnCode，删除ERROR_SYSTEM_EXCEPTION
- 【删除】ResultHeader，删除默认的traceId属性
v2.4.2
v2.4.0
v2.3.1
v2.2.1.RELEASE
新增
- 新增请求基础类：com.fengwenyi.api.result.BaseRequest
- 公共返回类(CommonResponse)，增加requestId字段
优化
- 公共返回类(CommonResponse)，字段traceId返回的key修改为traceId
v2.2.0.RELEASE
示例
{
"code":"111111",
"message":"Query Success",
"success":true,
"trace_id":"edf36a73796356d5bc9b6d81f4eb83d6",
"body":{
"categoryData":[
{
"id":"1265200246055809026",
"categoryName":"公告"
},
{
"id":"1257301514647777282",
"categoryName":"Java"
},
{
"id":"1257694082590060546",
"categoryName":"开发"
},
{
"id":"1257255039406452737",
"categoryName":"前端"
},
{
"id":"1257687302015299586",
"categoryName":"计划"
},
{
"id":"1258792800529727490",
"categoryName":"网站更新日志"
},
{
"id":"1257256132635013121",
"categoryName":"日志"
}
]
}
}实体类属性介绍
CommonResponse
| 序号 | 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|---|
| 1 | code | String | 返回码 | |
| 2 | message | String | 返回码描述信息 | |
| 3 | success | Boolean | false | 响应结果状态，true：表示成功；false：表示失败 |
| 4 | traceId | String | 追溯码，json格式返回时，为 trace_id |
|
| 5 | header | Map<String, String> | 响应头 | |
| 6 | body | 泛型 <T> |
响应体 |
CommonPage
| 序号 | 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|---|
| 1 | currentPage | Long | 当前页 | |
| 2 | pageSize | Integer | 每页显示条数 | |
| 3 | totalElements | Long | 总条数 | |
| 4 | totalPages | Long | 总页数 | |
| 5 | content | 泛型 <T> |
数据 |
返回方法介绍
返回成功
-
CommonResponse.ok()
-
CommonResponse.ok(data)
返回失败
-
CommonResponse.error()
-
CommonResponse.error(msg)
-
CommonResponse.error(code, msg)
-
CommonResponse.error(iError)
IError介绍
IError是返回码和描述信息的接口。
你可以在返回时，使用。
为了方便，提供了常见的错误，将其命名为 Default。
你可以直接使用 IError.Default。
值得注意的是：成功的返回码是6个1，字符型，111111 。