接口文檔規(guī)范

XXX接口說(shuō)明書（版本：V1.0）文檔編號(hào)保密等級(jí)作者最后修改日期審核人最后審批日期批準(zhǔn)人最后批準(zhǔn)日期XXX接口說(shuō)明XXX接口說(shuō)明#1簡(jiǎn)介1.1文檔目的接口文檔是前端與后端交互密不可分的環(huán)節(jié)，接口的規(guī)范性會(huì)直接影響雙方對(duì)接過(guò)程中的效率和質(zhì)量。本著快速高效開發(fā)的目的性，避免對(duì)接過(guò)程中的錯(cuò)誤率。1.2接口規(guī)范(1)遵循RESTfulAPI設(shè)計(jì)風(fēng)格數(shù)據(jù)格式采用json格式返回統(tǒng)一結(jié)構(gòu)數(shù)據(jù)例如：結(jié)構(gòu)：data(數(shù)據(jù))、errorCode(狀態(tài)碼)、msg(提示信息){data:{},//數(shù)據(jù)類型不一定為object類型errorCode:10001,msg:''}枚舉型參數(shù)應(yīng)列舉參數(shù)所有值及說(shuō)明例如：gender:性別(男：1,女：2)userinfo:{name:'張三’，age:23,gender:1}具有嵌套關(guān)系的參數(shù)應(yīng)指明嵌套關(guān)系及子級(jí)數(shù)據(jù)結(jié)構(gòu)例如：billList:賬單列表(父級(jí))billList:[{i:'001',billNam:'測(cè)試數(shù)據(jù)’,billstaut:1,addres:'雁塔區(qū)’}]返回參數(shù)數(shù)據(jù)類型保持一致性例如：billList:賬單列表(有數(shù)據(jù))billList:[{i:'001',billNam:'測(cè)試數(shù)據(jù)’,billstaut:1,addres:'雁塔區(qū)’}]billList:賬單列表(無(wú)數(shù)據(jù))billList:[]返回的參數(shù)數(shù)據(jù)類型都為：array下拉及選擇型數(shù)據(jù)以鍵值對(duì)的形式返回例如：orderOperate:訂單操作orderOperate:[{labe:'待開票'valu:1001},{labe:'回款'valu:1003}]⑻“操作類型”的接口必須返回msg信息內(nèi)容(9)返回的展示型數(shù)據(jù)應(yīng)具有可用性例如：createTime:生成時(shí)間(建議格式){createTime}建議:由于前臺(tái)處理數(shù)據(jù)能力較弱，故后臺(tái)返回的數(shù)據(jù)盡可能便于前臺(tái)使用2接口定義2.1特殊接口2.1.1獲取服務(wù)器sessionKey接口標(biāo)識(shí)：接口地址：/api/GetSessionKey請(qǐng)求方式：POST請(qǐng)求參數(shù)：參數(shù)名類型必填示例值默認(rèn)值描述appTypenumber是11l:e站,2:客戶codestring否wx.login返回的code輸出參數(shù)：參數(shù)名類型示例值默認(rèn)值描述errorCodenumber100100:成功,-99:失敗,-10:需要登錄—20:Session失效msgstring接口返回的文字消息datastringApi接口返回session值返回示例值:{data:'123456',errorCode:100,msg:}2.2通用接口2.2.1賬單列表接口標(biāo)識(shí)：接口地址：/api/billList請(qǐng)求方式：POST請(qǐng)求參數(shù)：參數(shù)名類型必填示例值默認(rèn)值描述idnumber是訂單idsortstring否排序gendernumber是11性別（男：1,女：2）orderListarray否[?“]訂單列表orderListorderldstring否訂單idorderNamestring否訂單名稱isStudentboolean是falsefalse是否學(xué)生（是：true,否：false）返回參數(shù)：參數(shù)名類型示例值默認(rèn)值描述dataarray[…]返回的數(shù)據(jù)dataidstring用戶idgendernumber11用戶性別（男：1,女：2）invoiceTitlestring抬頭addressstring地址billListarray[■■■]訂單列表數(shù)據(jù)billListidstring訂單idbillNamestring訂單名稱billStautsnumber11訂單狀態(tài)（待開票：1,回款:2,核銷：3）addressstring客戶地址userinfoobject{}用戶信息userInfonamename用戶姓名agenumber用戶年齡genderstring11用戶性別（男：1,女：2）errorCodenumber狀態(tài)信息msgstring信息提示返回示例值:{data:[{i:'1',gende:2,invoiceTitl:'帝國(guó)快運(yùn)’，addres:'陜西省西安市雁塔區(qū)科技路24號(hào)’，billLis:[{i:'001',billNam:'測(cè)試數(shù)據(jù)’，billstaut:1,addres:'雁塔區(qū)’},{i:'002',billNam:'測(cè)試數(shù)據(jù)02',billStaut:1,addres:'高新區(qū)’}],userInf:{nam:'張三’，ag:23,gende:1}},{i:'2',gende:1,invoiceTitl:'圓通快遞',addres:'陜西省西安市雁塔區(qū)科技路24號(hào)’，billLis:[{i:'003',billNam:'測(cè)試數(shù)據(jù)’，billStaut:1,addres:'雁塔區(qū)’},{i：'0