开发接口API模板

1、result如响应例子XXX项目接口文档版本控制信息版本口期描述作者2018-8-13创建XXX1 获取所有字段1.1获取所有字段请求地址:/session/field/findAII响应code10000成功，-1系统错误，10001必填参数为空请求参数参数名必填字段类型描述n ame是String根据名称筛选请求例子：响应例子：rcode”:"10000Texceptiorr：null,”isSuccess":truermessageT成功，系统处理正常!M,page,:0,pageSize,:0,retumObjecr,:null；,retumValueH:,type

2、s,:null；,villages,:nullJ,companysM:,iconColour,:,M,” iconSize”:0, "iconStyle”:”, ”id”:4,”name”:”XX”,”iconColour”:”,”iconSize”:(ri8nStyle”:：”id”:5,"name”:”XX”,”ico n Colour”:”, “icon Size”:0,”iconStyle”:”,”id”:7,”name”:”XX”, "totals”:。2 文件上传2.1文件上传（ajax）请求地址:/session/file/upload请求参数参数名

3、必填字段类型描述file是FormDataFormData对象包含的文件响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例了 ： var formData = new FormData();('"file； 0);$.ajax(url : routePath + Vsession/file/uploadH,type : 'POST',data : form Data,processData : false,contentType : false,success : function(result)

4、 result = (result);if =H10000u)('上传成功!*)；$(H#editHeadPortraitn).val响应例子：returnValue 里包含了 fileName 和 filePath3 字段管理所属类型3.1新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述n ame是String所属类型名称响应code10000成功一1系统错误 10001必填参数为空message响应描述result如响应例子成功，系统处理正常!请求例子：响应例子:"code":"10000",

5、"exception":null,"isSuccess":true,"message":"Tpage”:0rpageSize”:(VretumListSize”:0returnObject“:nulretumValue”:nultotals”:03.2修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idn ame是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例

6、子：&name=test响应例子："code":"10000","exception":null,'isSuccess":true,"message":"成功，系统处理正常!Tpage”:0pageSize”:0JetumListSize“:0retumO bjecttnulretumValue”:nultotals”:03.3根据id获取所属类型请求地址:/session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10

7、000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子："codetr OOOOTexceptiorT:nulisSuccess”:tnjemessageT成功 / 系统处理正常!Tpage”:0pageSize”:0retumListSize":(VretumObject”:nuirretumValue”：ricr：2rnameT're”rtotals”:03.4获取所属类型列表请求地址：/session/fieldType/selectAII请求参数参数名必填字段类型描述n ame否String根据类型名称

8、筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子： Hcode,':,10000,7，exceptionH:null,HisSuccess,:true,Hmessage,':n成功 / 系统处理正常!Tpage”:0pageSize”:(VreturnObjecttnulretumValue“:ricr：1，FameY123”ficr：6"ameY145555”totals“： 235删除所属类型（批量）请求地址：/session/fieldType/deleteBylds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子成功，系统处理正常!请求例子:响应例子:l,code,: