《开发接口文档-API文档模板.docx》由会员分享，可在线阅读，更多相关《开发接口文档-API文档模板.docx（4页珍藏版）》请在三一文库上搜索。
1、精品文档XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1获取所有字段请求地址：/session/field/findAII请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：http:/127.0.0.1:8080/session/fieId/findAII?name=X响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常！,page:0
2、,pageSize:0,returnObject:null,returnValue:types:null,villages:null,companys:iconColour:, iconSize:0,iconStyle:,id:4,name:XX,iconColour:,iconSize:0,iconStyle:,id:5,name:XX,iconColour:,iconSize:0,iconStyle:,id:7,name:XX,totals:02 文件上传2.1文件上传（ajax ）请求地址：/session/file/upload请求参数参数名必填字段类型描述file是FormDataF
3、ormData 对象包含的文件响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子： var formData = new FormData();formData.append(file, this.filesO);$.ajax(url : routePath + /session/file/upload,type : POST,data : formData,processData : false,contentType : false,success : function(result) result = JSON.parse
4、(result);if(result.code = 10000)layer.msg(上传成功！)； $(#editHeadPortrait).val(result.returnValue.filePath););响应例子：returnValue里包含了 fileName 和 filePath3 字段管理-所属类型3.1新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述name是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：http:/127.0.0.1
5、:8080/session/fieldType/save?name=13243434响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:03.2修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为
6、空message响应描述result如响应例子请求例子：http:/127.0.0.1:8080/session/fieldType/update?id=2&name=test响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:03.3根据id获取所属类型请求地址：/session/fieldType/getByld请求参数参数名必填字段类型描述id是Long所属类
7、型id响应code10000成功，-1系统错误，10001必填参数为空message响应描述精品文档result如响应例子请求例子：http:/127.0.0.1:8080/session/fieldType/getByld?id=2响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:id:2,name:re,totals:03.4获取所属类型列表请求地址：/session/fieldTy
8、pe/selectAll请求参数参数名必填字段类型描述name否String根据类型名称筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：http:/127.0.0.1:8080/session/fieldType/selectAll?name=1响应例子：code:10000,exception:null,isSuccess:true,message:成功，系统处理正常！,page:0,pageSize:0,returnObject:null,returnValue:id:1,name:123,id:6,name:145
9、555,totals:2响应例子：code:10000,exception:null,isSuccess:true,message:3.5删除所属类型（批量）请求地址：/session/fieldType/deleteBylds请求参数参数名必填字段类型描述ids是List所属类型id集合code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子响应请求例子：http:/127.0.0.1:8080/session/fieldType/deleteByIds?ids=1成功，系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:0