api-resultAPI 接口返回結(jié)果規(guī)范化解決方案
API 接口開發(fā)返回結(jié)果規(guī)范化解決方案
一、概述
Api Result，是 RESTful風格的API接口響應(yīng)參數(shù)規(guī)范化的一套解決方案 。它是在實際應(yīng)用環(huán)境下產(chǎn)生了，并不斷更新和完善。 結(jié)合Spring Boot進行開發(fā)，讓接口響應(yīng)結(jié)果變得更加規(guī)范。
二、示例
{
"code":"111111",
"message":"Query Success",
"success":true,
"trace_id":"edf36a73796356d5bc9b6d81f4eb83d6",
"body":{
"categoryData":[
{
"id":"1265200246055809026",
"categoryName":"公告"
},
{
"id":"1257301514647777282",
"categoryName":"Java"
},
{
"id":"1257694082590060546",
"categoryName":"開發(fā)"
},
{
"id":"1257255039406452737",
"categoryName":"前端"
},
{
"id":"1257687302015299586",
"categoryName":"計劃"
},
{
"id":"1258792800529727490",
"categoryName":"網(wǎng)站更新日志"
},
{
"id":"1257256132635013121",
"categoryName":"日志"
}
]
}
}
三、實體類屬性介紹
CommonResponse
| 序號 | 屬性 | 類型 | 默認值 | 說明 |
|---|---|---|---|---|
| 1 | code | String | 返回碼 | |
| 2 | message | String | 返回碼描述信息 | |
| 3 | success | Boolean | false | 響應(yīng)結(jié)果狀態(tài)，true：表示成功；false：表示失敗 |
| 4 | traceId | String | 追溯碼，json格式返回時，為 trace_id |
|
| 5 | header | Map<String, String> | 響應(yīng)頭 | |
| 6 | body | 泛型 <T> |
響應(yīng)體 |
CommonPage
| 序號 | 屬性 | 類型 | 默認值 | 說明 |
|---|---|---|---|---|
| 1 | currentPage | Long | 當前頁 | |
| 2 | pageSize | Integer | 每頁顯示條數(shù) | |
| 3 | totalElements | Long | 總條數(shù) | |
| 4 | totalPages | Long | 總頁數(shù) | |
| 5 | content | 泛型 <T> |
數(shù)據(jù) |
四、返回方法介紹
返回成功
-
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 。
六、中央倉庫
評論
圖片
表情