HTTP請(qǐng)求一般采用GET 和 POST:

• GET 請(qǐng)求參數(shù)格式為Key=Value
• POST請(qǐng)求參數(shù)格式為JSON

響應(yīng)數(shù)據(jù)格式

{
    "code": 0,   // 0為成功 | 小于0為失敗 | 大于0為成功且其他某種狀態(tài)
    "message": "失敗原因",
    "data": null // 數(shù)據(jù) 為空時(shí)為null 
}

• 成功:

{
    "code": 0, 
    "message": "請(qǐng)求成功",
    "data": { 
        "name": "LEE",
        "age": 27
     } 
}

• 失敗:

{
    "code": -9999, 
    "message": "身份鑒權(quán)無(wú)效"
}

其他個(gè)例

時(shí)間數(shù)據(jù)類型 使用毫秒單位時(shí)間戳 (整型)

• 建議:

{
    "time": 153442323000    // ms
}

金額數(shù)據(jù)類型 使用分單位 (整型)

• 建議:

{
    "price": 1200    // 12元 = 1200分
}

是與否數(shù)據(jù)類型 使用0或1 (整型)

• 不建議:

{
    "isVip": 0 
}

• 建議:

{
    "vip": 0    // 0: 不是會(huì)員, 1: 是會(huì)員 
}

狀態(tài)(State)或類型(Type)數(shù)據(jù)類型 使用1, 2, 3, 4... (整型)

• 建議:

{
    "state": 1,    // 1: xxx, 2: xxx, 3: xxx
    "type": 2      // 1: xxx, 2: xxx, 3: xxx
}

數(shù)組數(shù)據(jù)類型 為空則使用 []

• 不建議:

{
    "list": null 
}

• 建議:

{
    "list": [] 
}

字段命名遵循駝峰命名法, 且不進(jìn)行冗余命名. 例如:

• 不建議:

{ 
    "xxxx": 1,
    "xxxx": "xxxx",
    "xxx_xxxx_xx": "xxx",
    "video": {
        "videoCode": "xxxx",
        "videoName": "xxxx",
        "videoImage": "xxxx"
    }
}

• 建議:

{ 
    "xxxx": 1,
    "xxxx": "xxxx",
    "video": {
        "code": "xxxx",
        "name": "xxxx",
        "image": "xxxx"
    }
}

字段命名保持統(tǒng)一風(fēng)格, 相同類型或含義的字段名風(fēng)格保持統(tǒng)一

• 不建議:

{ 
    "xxImg":"xxx",
    "xxPic":"xxx",
    "xxImage":"xxx",
    "xxPicture":"xxx",
    "xxPhoto": "xx",
    "xxImgUrl": "xx",
    "xxPicURL": "xx"
    
    "xxNum": 0,
    "xxCount": 0,
    "xxNumber": 0
}

所有可能為null 或者可能不存在的字段需在文檔中用注釋標(biāo)明 (不標(biāo)注的默認(rèn)認(rèn)為不會(huì)為空)

• 建議:

{ 
    "xxxx": 1,
    "xxxx": "xxxx",        
    "video": {             
        "code": "xxxx",    
        "name": "xxxx",    // 無(wú)xx時(shí)為空字符串
        "image": "xxxx"    // 無(wú)xx時(shí)為null
    },
    "list": []
}

個(gè)數(shù) 數(shù)量的數(shù)據(jù)類型使用整型

• 不建議:

{ 
    "xxCount": "122",
    "xxNumber": "2333"
}

• 建議:

{ 
    "xxCount": 122,
    "xxNumber": 2333
}

百分比數(shù)據(jù)類型使用整型

• 建議:

{
    "progress": 98    // 進(jìn)度百分比 0 - 100 
}