開發(fā)接口文檔-API文檔模板_第1頁
開發(fā)接口文檔-API文檔模板_第2頁
開發(fā)接口文檔-API文檔模板_第3頁
免費預(yù)覽已結(jié)束，剩余1頁可下載查看

下載本文檔

版權(quán)說明：本文檔由用戶提供并上傳，收益歸屬內(nèi)容提供方，若內(nèi)容存在侵權(quán)，請進(jìn)行舉報或認(rèn)領(lǐng)

文檔簡介

1、XXX項目接口文檔版本控制信息版本日期描述作者V1.02018-8-13創(chuàng)建XXX1 獲取所有字段1.1獲取所有字段請求地址：/session/field/findAII請求參數(shù)參數(shù)名必填字段類型描述name是String根據(jù)名稱篩選響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fieId/findAII?name=X響應(yīng)例子："code":"10000","exception":null,"is

2、Success":true,"message":"成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":"types":null,"villages":null,"companys":"iconColour":"", "iconSize":0,"iconSt

3、yle":"","id":4,"name":"XX","iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX","iconColour":"","iconSize":0,"iconStyle":&quo

4、t;","id":7,"name":"XX","totals":02 文件上傳2.1文件上傳（ajax ）請求地址：/session/file/upload請求參數(shù)參數(shù)名必填字段類型描述file是FormDataFormData 對象包含的文件響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子： var formData = new FormData();formData.append("file", this.file

5、sO);$.ajax(url : routePath + "/session/file/upload",type : 'POST',data : formData,processData : false,contentType : false,success : function(result) result = JSON.parse(result);if(result.code = "10000")layer.msg('上傳成功！)； $("#editHeadPortrait").val(result.ret

6、urnValue.filePath););響應(yīng)例子：returnValue里包含了 fileName 和 filePath3 字段管理-所屬類型3.1新增所屬類型請求地址：/session/fieldType/save請求參數(shù)參數(shù)名必填字段類型描述name是String所屬類型名稱響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fieldType/save?name=13243434響應(yīng)例子："code":"10000",&qu

7、ot;exception":null,"isSuccess":true,"message":"成功，系統(tǒng)處理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.2修改所屬類型請求地址：/session/fieldType/update請求參數(shù)參數(shù)名必填字段類型描述id

8、是Long所屬類型idname是String所屬類型名稱響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fieldType/update?id=2&name=test響應(yīng)例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系統(tǒng)處理正常!","page&q

9、uot;:0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.3根據(jù)id獲取所屬類型請求地址：/session/fieldType/getByld請求參數(shù)參數(shù)名必填字段類型描述id是Long所屬類型id響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fi

10、eldType/getByld?id=2響應(yīng)例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系統(tǒng)處理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":"id":2,&

11、quot;name":"re","totals":03.4獲取所屬類型列表請求地址：/session/fieldType/selectAll請求參數(shù)參數(shù)名必填字段類型描述name否String根據(jù)類型名稱篩選響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fieldType/selectAll?name=1響應(yīng)例子："code":"10000","exception&q

12、uot;:null,"isSuccess":true,"message":"成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":"id":1,"name":"123","id":6,"name":"145555","totals":23.5刪除所屬類型（批量）請求地址：/session/fieldType/deleteBylds請求參數(shù)參數(shù)名必填字段類型描述ids是List所屬類型id集合響應(yīng)code10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/fieldType/deleteByIds?ids=1響應(yīng)例子："code":"10000","exception":null,"isSuccess":true,"m

溫馨提示

  • 1. 本站所有資源如無特殊說明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽，若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間，僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理，對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯，并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容，請與我們聯(lián)系，我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論