個人編寫的用于對接Java后臺的部分功能的API文檔近哟。系Android端編寫唱星。
ChenH整理
序
- 此API文檔主要為確定各個接口的JSON數(shù)據(jù)大間架結(jié)構(gòu)
- 至于具體的JSON數(shù)據(jù)，可根據(jù)實際情況增刪墩弯，增刪后兰英，互相拷貝JSON對應的JavaBean即可
- 新版APP的測試數(shù)據(jù)即是基于此接口模型編寫
測試服務器
正式服務器
登錄
-
接口地址
-
接口請求參數(shù)說明
參數(shù) 類型 說明 實例 備注 name String 賬戶名 李白 無 paw String 密碼 123456 無 -
接口實例
http://URL:1041/URL?name=李白&Paw=123456
-
返回結(jié)果(JSON)
{ "resultCode": 1， "mMessage": "請求成功", "newTimestamp": 1514377402614, "dataSource":{ "UserID": 5, "UserName": "ChenH" } } -
返回結(jié)果說明
resultCode:請求狀態(tài):0:失敗;1:成功; 2:服務器異常
mMessage:提示信息
newTimestamp:時間戳
dataSource:用戶信息數(shù)據(jù)
? userId:用戶ID
? userName:用戶名
? 以上字段可根據(jù)具體需要增刪
測試任務
根據(jù)用戶ID拉取
-
接口地址
-
接口請求說明
參數(shù) 類型 說明 實例 備注 userId String 用戶ID 12345 無 根據(jù)需要新增 根據(jù)需要新增 -
接口實例
http://URL:1041/URL?userId=李白&其余參數(shù)待補全
-
返回結(jié)果(JSON)
{ "mMessage": "請求成功", "newTimestamp": 1514377402614, "resultCode": 1, "dataSource": [ { "planId": 0, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "譫臺浮萍" }, { "planId": 1, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "譫臺浮萍" }, { "planId": 2, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "譫臺浮萍" } ] } -
返回結(jié)果說明
resultCode:請求狀態(tài):0:失敗;1:成功; 2:服務器異常
mMessage:提示信息
newTimestamp:時間戳
dataSource:測試任務數(shù)據(jù)蜗搔，一個用戶可以有多個測試任務
? planId:測試任務ID
? testAddress:測試地(每個基站都有地址劲藐，所以這個字段可以不要)
? testDate:測試時間
? testUser:測試人
? 以上字段可根據(jù)具體需要增刪
獲取基站
根據(jù)任務ID拉取
-
接口地址
-
接口參數(shù)說明
參數(shù) 類型 說明 實例 備注 planId String 測試任務ID 1001 無 根據(jù)需要新增 -
接口實例
http://URL/URL?planId=1001&其余參數(shù)待補全
-
返回結(jié)果(JSON)
{ "mMessage": "請求成功", "newTimestamp": 1514377609658, "resultCode": 1, "dataSource": [ { "mBaseStationAddress": "張愛玲故居", "mBaseStationDistance": "7.7km", "mBaseStationNumber": "777770", "mBaseStationType": "XXX", "mLatitude": "119.3232", "mLongitude": "78.4556", "mSector": "109", "mCommunityBeanList": [ { "mCommunityBeanName": "小區(qū)0", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping" ], "mNodeBID": "61088", "mPci": "260", "mTac": "40960" }, { "mCommunityBeanName": "小區(qū)1", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping", "接通時延", "PCI" ], "mNodeBID": "61088", "mPci": "261", "mTac": "40960" } ] }, { "mBaseStationAddress": "外灘十八號", "mBaseStationDistance": "7.7km", "mBaseStationNumber": "777770", "mBaseStationType": "XXX", "mLatitude": "119.3232", "mLongitude": "78.4556", "mSector": "109", "mCommunityBeanList": [ { "mCommunityBeanName": "小區(qū)0", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping" ], "mNodeBID": "61088", "mPci": "260", "mTac": "40960" }, { "mCommunityBeanName": "小區(qū)1", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping", "接通時延", "PCI" ], "mNodeBID": "61088", "mPci": "261", "mTac": "40960" } ] } ] } -
返回結(jié)果說明
resultCode:請求狀態(tài):0:失敗;1:成功; 2:服務器異常
mMessage:提示信息
newTimestamp:時間戳
dataSource:測試基站數(shù)據(jù)，一個測試任務可以對應多個基站
mBaseStationAddress:基站地址
? mBaseStationDistance:距離基站的距離
mLongitude:基站經(jīng)度
? mLatitude:基站緯度
? mSector:扇區(qū)
mBaseStationType:基站類型
? mBaseStationNumber:基站編號
? mCommunityBeanList:每個基站對應的測試小區(qū)樟凄，一個基站可以對應多個測試小區(qū)
? mCommunityBeanName:小區(qū)名或小區(qū)編號
? mNodeBID:NodeBID
? mPci:物理小區(qū)標識
? mTac:跟蹤區(qū)域碼
? mCommunityTestItemList:小區(qū)對應測試項聘芜，一個小區(qū)會有多個測試項
? 以上字段可根據(jù)具體需要增刪
上傳測試結(jié)果
上傳測試好的結(jié)果值，是字符串
-
接口地址
-
接口參數(shù)說明
參數(shù) 類型 說明 實例 備注 userId String 用戶ID 12345 無 planId String 測試任務ID 1001 無 up_RSRP String RSRP 90 無 up_SINR String SINR 8 無 up_PingDelay String ping時延 5000ms 無 up_PCI String PCI 261 無 up_RSSI String RSSI 56 無 up_CELLID String CELLID 2344 無 up_UplinkRate String XXX 13.5Kbps 無 up_DownstreamRate String XXX 9Kbps 無 具體上傳字段根據(jù)每個小區(qū)的測試項來定缝龄，可增刪 -
接口實例
-
返回結(jié)果(JSON)
{ "resultCode": 1汰现， "mMessage": "上傳成功", "newTimestamp": 1514377402614, "dataSource":null } -
返回結(jié)果說明
resultCode:請求狀態(tài):0:失敗;1:成功; 2:服務器異常
mMessage:提示信息
newTimestamp:時間戳
dataSource:無
? 以上字段可根據(jù)具體需要增刪
上傳測試Log文件
此接口于主流程邏輯關(guān)聯(lián)不大挂谍，可自行補充
- 接口地址
- 接口參數(shù)說明
- 接口實例
- 返回結(jié)果(JSON)
- 返回結(jié)果說明
跋
- 以上API僅提供JSON結(jié)構(gòu)參考
- 只要JSON大結(jié)構(gòu)不變，關(guān)于命名或字段的數(shù)目服鹅，可以自行修改
- 此API設計是針對新版APP的界面邏輯凳兵。如邏輯有紕漏，可一起商榷修正
- 具體需要展示的字段企软，根據(jù)用戶需求做增刪
- 包內(nèi)提供JavaBean
由于對接工作緊迫庐扫，文檔編寫倉促，難免不足仗哨，共勉形庭。
