开发接口API模板

1、XXX项目接口文档版本控制信息版本口期描述作者2018-8-13创建XXX1 获取所有字段1.1获取所有字段请求地址:/session/field/findAII响应code10000成功，-1系统错误，10001必填参数为空请求参数参数名必填字段类型描述message响应描述n ame是Stri ng根据名称筛选请求例子：响应例子：rcode” ："10000Texceptiorr: null, ” isSuccess":truermessageT成功，系统处理正常！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）请求地址:/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData对象包含的文件code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例了： 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响应例子：returnValue 里包含了 fileName 和 filePath3 字段管理？所属类型3.1新增所属类

5、型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述n ame是Stri ng所属类型名称响应message响应描述如响应例子result成功，系统处理正常请求例子：响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"Tpage” :0rpageSize (VretumListSize ”OeturnObject“:ndetumValue ” :nuf totals ” :

6、03.2修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idn ame是Stri ng所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：&n ame=test响应例子："code":"10000","exception":null, !'isSuccess":true,"message":"成功，系统处理正常Tpage” ：0

7、pageSize ” ：OJetumListSizeTeiumO bjecttnul retumValue ” :nuT totals ” :03.3根据id获取所属类型message响应描述请求地址 : /session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子:"codetr OOOOTexceptiorT:nulisSuccess ” ：tnjemessageT成功/系统处理正常Tpage” ：0page

8、Size ” ：retumListSize": (VretumObject ” ：nuirretumValue: ricr: 2rnameT're ” rtotals ” :03.4获取所属类型列表请求地址：/sessi on /fieldType/selectAII请求参数参数名必填字段类型描述n ame否Stri ng根据类型名称筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子:Hcode,':,10000 7 exception H：null, HisSuccess ,:true, Hmessage ,':n成功/系统处理正常Tpage” ：0pageSize ”（：returnObjecttnul retumValue “:ricr 1, FameY123 ficr: 6"ameY145555'totals :“ 23? 5删除所属类型（批量）请求地址：/sessi on /fieldType/deleteBylds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子成功，系统处理正常请求例子:响应例子:l,code,:f,