1.HTTP
1.1全局規(guī)范
URL
URL的組成:基本的網(wǎng)絡(luò)地址 + 分支節(jié)點(diǎn)
http://172.19.201.155/iqasweb/ 為 基本的網(wǎng)絡(luò)地址
/login 為 分支節(jié)點(diǎn)
http://172.19.201.155:8443/datasyn/login 組成完整的 URL
當(dāng)前統(tǒng)一的基本網(wǎng)絡(luò)地址為 http://172.19.201.155/iqasweb/請(qǐng)求方式
|POST
|GET請(qǐng)求消息頭
請(qǐng)求參數(shù)
鍵值對(duì)(key value形式)
默認(rèn)都是必選參數(shù)請(qǐng)求參數(shù)
鍵值對(duì)(key value形式)響應(yīng)的狀態(tài)碼
統(tǒng)一的返回碼為: 200 (注:只要訪問(wèn)服務(wù)器成功,一律返回200)響應(yīng)的格式
Json響應(yīng)的JSON規(guī)范
成功
{
"status": 1,
"message": "",
"data": ...
}
成功的標(biāo)記為 status為 1
根據(jù)具體的請(qǐng)求,如果需要返回值 data節(jié)點(diǎn) 包含的是 返回結(jié)果
不需要需要返回值 ,則沒(méi)有data節(jié)點(diǎn)
- 失敗
{
"status": 錯(cuò)誤編碼,
"message": "錯(cuò)誤原因",
"data": null
}
失敗的標(biāo)記為 status為 除1以外的其它編碼
status不為1時(shí),message為錯(cuò)誤原因
1.2目前包含資源
包含4年級(jí)和5年級(jí)單詞
5年級(jí)目前只包含apple一個(gè)單詞及其相關(guān)資源
2. 獲取離線包下載鏈接接口
- 分支節(jié)點(diǎn) :
/mobile/offline/getOffLineBag4ios.html - 請(qǐng)求方式 :
POST - 請(qǐng)求參數(shù)
| key | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| realGrade | int | 實(shí)際年級(jí) |
| themenumber | String | 主題編號(hào),如2-12 |
- 響應(yīng)結(jié)果 :
- 成功
{
"status": 1,
"message": "",
"data": [
{
"id": "2482bcd23802eb0a26b3d9ff5d4da6cc",
"name": "ios-2-12-4-3",
"downUrl": "mobile/offline/downofflinebag.html"
},
{
"id": "f67b9675f6593df5c7293aa8edd99fbe",
"name": "ios-2-12-4-4",
"downUrl": "mobile/offline/downofflinebag.html"
},
{
"id": "c7115a5c84119aa2d3106aa04f034591",
"name": "ios-2-12-4-5",
"downUrl": "mobile/offline/downofflinebag.html"
}
]
}
- 失敗
| status | message |
|---|---|
| 其它 | 有可能出現(xiàn)未知異常,還沒(méi)有對(duì)異常進(jìn)行全局處理 |
3.離線包下載接口
- 分支節(jié)點(diǎn) :
/mobile/offline/downofflinebagforios.html - 請(qǐng)求方式 :
POST - 請(qǐng)求參數(shù)
| key | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| id | String | 要下載的離線包的鏈接,從上面一個(gè)接口獲取 |
- 響應(yīng)結(jié)果 :
- 成功
文件傳輸流
- 失敗
| status | message |
|---|---|
| 其它 | 有可能出現(xiàn)未知異常,還沒(méi)有對(duì)異常進(jìn)行全局處理 |