資源描述：
《app開發(fā)規(guī)范—app接口開發(fā)規(guī)范文檔 v1.0》由會員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。
1、~~{北京天晴APP接口規(guī)范文檔}手機(jī)客戶端接口文檔文件狀態(tài)：[]草稿[√]正式發(fā)布[]正在修改文件標(biāo)識：當(dāng)前版本：1.0作者：北京天晴完成日期：~~~~~版本歷史版本/狀態(tài)作者參與者起止日期備注V1.0/草稿韓磊移動小組~~~~~目錄一、概述11.1有關(guān)接口11.1.1接口是純數(shù)據(jù)的交互11.2接口的分類11.2.1查詢類接口11.2.2操作類接口11.2.3上傳下載類接口11.2.4推送類接口1二、查詢類接口格式規(guī)范12.1獲取單條對象信息12.1.1請求格式12.1.2參數(shù)說明22.1.3正常返回結(jié)果22.2獲取列表對象信息22.2.1請求格式22.2.2參數(shù)說明32.2.3正常返回結(jié)
2、果3三、操作類接口43.1新增操作43.1.1接口說明43.1.2參數(shù)說明43.1.3正常返回結(jié)果43.1.4錯誤返回列表43.2修改操作53.2.1接口說明53.2.2參數(shù)說明53.2.3正常返回結(jié)果53.2.4錯誤返回列表53.3刪除操作53.3.1接口說明53.3.2參數(shù)說明63.3.3正常返回結(jié)果63.3.4錯誤返回列表6四、上傳下載類64.1上傳文件64.1.1接口說明64.1.2參數(shù)說明74.1.3正常返回結(jié)果74.1.4錯誤返回列表74.2下載文件74.2.1接口說明7~~~~~4.2.2參數(shù)說明74.2.3正常返回結(jié)果84.2.4錯誤返回列表8五、推送類接口85.1推送消息8
3、5.1.1接口說明85.1.2參數(shù)說明85.1.3正常返回結(jié)果85.1.4錯誤返回列表8六、通用返回格式96.1正確返回96.1.1接口說明96.1.2參數(shù)說明96.1.3正常返回結(jié)果96.1.4錯誤返回列表96.2錯誤返回96.2.1接口說明96.2.2參數(shù)說明106.2.3正常返回結(jié)果106.2.4錯誤返回列表10七、附錄107.1通用錯誤返回列表107.2URL地址信息117.2.1主機(jī)地址117.2.2URL列表117.3安全機(jī)制117.3.1驗(yàn)證簽名機(jī)制117.4其他117.2.1列表數(shù)據(jù)為空的返回11~~~~~一、概述1.1有關(guān)接口1.1.1接口是純數(shù)據(jù)的交互APP接口是移動設(shè)備
4、和業(yè)務(wù)之間進(jìn)行通信的途徑。實(shí)質(zhì)就是以特定的規(guī)則通過接口直接操作數(shù)據(jù)庫的增刪改查。1.2接口的分類1.2.1查詢類接口查詢類接口是指客戶端傳遞一些參數(shù)，服務(wù)端根據(jù)參數(shù)依據(jù)需求，前往數(shù)據(jù)庫查詢需要的結(jié)果返回?cái)?shù)據(jù)的一類接口。返回類型一般有兩種。第一種是返回一個對象，第二種是返回一個數(shù)組對象。第一種比如登陸，客戶端把用戶名密碼上傳到接口，服務(wù)器返回用戶的個人信息。第二種比如獲取客戶，客戶端把用戶的身份信息上傳到接口，服務(wù)器返回此身份下的所有客戶數(shù)組集合。1.2.2操作類接口操作類接口是指，客戶端通過接口進(jìn)行一些增刪改的操作。比如新增一個客戶，修改客戶信息，或者刪除一個客戶。服務(wù)器一般返回執(zhí)行的狀態(tài)，
5、有的需要返回執(zhí)行結(jié)果的一些信息，比如新增客戶后，返回客戶的ID。1.2.3上傳下載類接口上傳下載類接口是涉及到文件傳輸?shù)慕涌?。比如上傳頭像，需要上傳圖片到服務(wù)器，服務(wù)端根據(jù)需求響應(yīng)保存并返回結(jié)果。比如客戶端需要顯示用戶頭像，需要讀取網(wǎng)絡(luò)圖片文件，在手機(jī)上進(jìn)行顯示。1.2.4推送類接口除了客戶端主動去請求服務(wù)端，獲取需要信息之外。有時候，也存在服務(wù)端有消息需要通知客戶端的情況，這時候就是服務(wù)端向客戶端發(fā)送消息。這類需求可以通過客戶端短時間類循環(huán)請求解決，也可以通過第三方專業(yè)推送解決。也可以通過自己使用socket或者xmpp等協(xié)議進(jìn)行開發(fā)。二、查詢類接口格式規(guī)范2.1獲取單條對象信息2.1.1
6、請求格式URL支持格式JOSN~~~~~HTTP請求方式POST是否登錄驗(yàn)證請求數(shù)限制2.1.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名2.1.3正常返回結(jié)果返回鍵類型返回值說明resultString結(jié)果代碼信號ok結(jié)果成功，fail結(jié)果失敗ResponseObject響應(yīng)體Key1int響應(yīng)字段值Key2String響應(yīng)字段值Key3Object響應(yīng)字段值可以依然包含對象體Key3_Key1int響應(yīng)字段值{"result":"ok","Response":{"userName":"Mary","sex":1,"Address":[{"city":"JiNan"}
7、,{"county":"LiXia"}]}}2.1.4錯誤返回列表詳見：通用錯誤返回列表~~~~~2.2獲取列表對象信息2.2.1請求格式URL支持格式JOSNHTTP請求方式POST是否登錄驗(yàn)證請求數(shù)限制2.2.2參數(shù)說明參數(shù)名必選類型及范圍說明xxxtrueString用戶名Pagefalseint第幾頁，不傳遞默認(rèn)第一頁Sizefalseint一頁多少條，不傳遞默認(rèn)20條2.2.3正常返回結(jié)果返回鍵類型
