如何設計接口

請求:

{
    "header":{
        "version":"1.0.0",
        "pageIndx":1,
        "pageSize":20,
        "client":"and/iOS/web"
    },
    "body":{}
}

header:通常須要區分app使用的版本、客戶端的來源,更多關於客戶端的統計都放到header部分中
body:部分用於業務數據的存放,這樣對於業務數據沒有過多的影響,層次分別web

返回:

{
    "code":"101",
    "msg":"獲取成功",
    "array":[],
    "obj":{},
    "pageIndx":1,
    "pageSize":20,
    "totalPage":8
}

code:後臺返回的狀態碼(通常成功操做爲0或000)
msg:後臺的操做提示(客戶端可直接使用該提示語句)
array:存放一些可用於展現分頁的數據
obj:存放其餘數據(如:分類信息)
pageIndx:當前分頁Index
pageSize:當前分頁數據大小
totalPage:共多少頁json

相關文章
相關標籤/搜索