開(kāi)發(fā)接口API模板

1、XXX項(xiàng)目接口文檔版本控制信息版本口期描述作者2018-8-13創(chuàng)建XXX1 獲取所有字段1.1獲取所有字段請(qǐng)求地址:/session/field/findAII響應(yīng)code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空請(qǐng)求參數(shù)參數(shù)名必填字段類型描述message響應(yīng)描述n ame是Stri ng根據(jù)名稱篩選請(qǐng)求例子：響應(yīng)例子：rcode” ："10000Texceptiorr: null, ” isSuccess":truermessageT成功，系統(tǒng)處理正常！MjpagerOjpageSize ,:0,retumObjecr': null; 're

2、tumValue H:"types"： null; 'villages "： nullj”compa nys M:”ic on Colour "：,M,” iconSize ” :0, "iconStyle ” : "” , "id ” :4, ” namW' : ” XX , (ri8nSCyotou： : id"" ：5,"n0raeSize"” XX” , " ico n Colour“ icon Size " :0, " iconS

3、tyle " : " " , " id " :7, " namg' : " XX , "totals ":2 文件上傳2.1文件上傳（ajax）請(qǐng)求地址:/session/file/upload請(qǐng)求參數(shù)參數(shù)名必填字段類型描述file是FormDataFormData對(duì)象包含的文件code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請(qǐng)求例了： var formData"=" new_FormData();('"

4、file; 0);$.ajax(url : routePath + Vsessi on /file/upload H,type : 'POST',data : form Data,processData : false,conten tType : false,success : fun cti on( result) result = (result);if =H10000u)('上傳成功!*);$(H#editHeadPortrait n).val響應(yīng)例子：returnValue 里包含了 fileName 和 filePath3 字段管理？所屬類型3.1新增所屬類

5、型請(qǐng)求地址：/session/fieldType/save請(qǐng)求參數(shù)參數(shù)名必填字段類型描述n ame是Stri ng所屬類型名稱響應(yīng)message響應(yīng)描述如響應(yīng)例子result成功，系統(tǒng)處理正常請(qǐng)求例子：響應(yīng)例子:"code":"10000","exception":null,"isSuccess":true,"message":"Tpage” :0rpageSize (VretumListSize ”O(jiān)eturnObject“:ndetumValue ” :nuf totals ” :

6、03.2修改所屬類型請(qǐng)求地址：/session/fieldType/update請(qǐng)求參數(shù)參數(shù)名必填字段類型描述id是Long所屬類型idn ame是Stri ng所屬類型名稱響應(yīng)code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請(qǐng)求例子：&n ame=test響應(yīng)例子："code":"10000","exception":null, !'isSuccess":true,"message":"成功，系統(tǒng)處理正常Tpage” ：0

7、pageSize ” ：OJetumListSizeTeiumO bjecttnul retumValue ” :nuT totals ” :03.3根據(jù)id獲取所屬類型message響應(yīng)描述請(qǐng)求地址 : /session/fieldType/getById請(qǐng)求參數(shù)參數(shù)名必填字段類型描述id是Long所屬類型id響應(yīng)code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請(qǐng)求例子：響應(yīng)例子:"codetr OOOOTexceptiorT:nulisSuccess ” ：tnjemessageT成功/系統(tǒng)處理正常Tpage” ：0page

8、Size ” ：retumListSize": (VretumObject ” ：nuirretumValue: ricr: 2rnameT're ” rtotals ” :03.4獲取所屬類型列表請(qǐng)求地址：/sessi on /fieldType/selectAII請(qǐng)求參數(shù)參數(shù)名必填字段類型描述n ame否Stri ng根據(jù)類型名稱篩選響應(yīng)code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請(qǐng)求例子：響應(yīng)例子:Hcode,':,10000 7 exception H：null, HisSuccess ,:true, Hmessage ,':n成功/系統(tǒng)處理正常Tpage” ：0pageSize ”（：returnObjecttnul retumValue “:ricr 1, FameY123 ficr: 6"ameY145555'totals :“ 23? 5刪除所屬類型（批量）請(qǐng)求地址：/sessi on /fieldType/deleteBylds請(qǐng)求參數(shù)參數(shù)名必填字段類型描述ids是List所屬類型id集合響應(yīng)code10000成功，-1系統(tǒng)錯(cuò)誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子成功，系統(tǒng)處理正常請(qǐng)求例子:響應(yīng)例子:l,code,:f,