開發(fā)接口文檔API文檔模板

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

2、sSuccess":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.files0

5、);$.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.r

6、eturnValue.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",&q

7、uot;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ù)名必填字段類型描述

8、id是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

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

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

11、2,"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","excepti

12、on":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/deleteByIds請求參數(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&