1. 程式人生 > >經驗分享-API介面響應格式規範定義

經驗分享-API介面響應格式規範定義

俗話說無規矩不成方圓,一個介面一種資料響應格式,一個開發人員一種開發格式,導致程式碼不規範,資料解析複雜化,維護更是難上加難。

1.關於介面響應資料格式參考[json格式],做到不使用的屬性不返回

基礎響應格式【其他格式在此格式上進行擴充套件】

{
"code":100,
"msg":"ok",
}

物件格式【物件資料存在】物件資料不存在,使用基礎響應格式

e:個人資訊為例

{
"code":100,
"msg":"ok",
"data":{
        "id":100,
        "name":"小偉",
        "age":20,
        "sex":0
    }

}

陣列格式【陣列可以物件陣列,字元陣列】【陣列不存在,使用基礎響應格式】


{
"code":100,
"msg":"ok",
"data":[
{
                "id":1,
                "name":"小王",
                "age":10
            }
,
{
                "id":1,
                "name":"小王",
                "age":10
            }

        ]

}

分頁列表格式【分頁結果】【分頁資料不存在,使用基礎響應格式】

{
"code":100,
"msg":"ok",
"data":{
        "nowPage"

:1,
        "totalPage":10,
        "list":[
            {
                "id":1,
                "name":"小王",
                "age":10
            }
,
            {
                "id":1,
                "name":"小王",
                "age":10
            }

        ]

    }
}

按照以上的劃分,是可歸為一型別物件型別,data可以為是陣列,自定義物件,分頁物件,使用Java作為開發語言,可以直接定義一個請求響應泛型類,

e:基礎解析類

public class ReqBase {

    /**響應碼*/
public int code;
/**響應碼相關提示資訊*/
public int msg;
}
物件響應泛型型別
public class ReqObjectT<T> extends  ReqBase{

    /**資料*/
public T data;
}

介面響應資料格式中,圖片地址必須給出完整的地址