1、XXX项目接口文档版本控制信息版本 日期 描述 作者V1.0 2018-8-13 创建 XXX1 获取所有字段1.1获取所有字段请求地址:/session/field/findAll请求参数参数名 必填 字段类型 描述name 是 String 根据名称筛选响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:http:/127.0.0.1:8080/session/field/findAll?name=X响应例子:“code“:“10000“,“exception“:null,“isSuccess“:true,“me
2、ssage“:“成功,系统处理正常!“,“page“:0,“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“,“
3、totals“:02 文件上传2.1文件上传(ajax)请求地址:/session/file/upload请求参数参数名 必填 字段类型 描述file 是 FormData FormData 对象包含的文件响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:var formData = new FormData();formData.append(“file“, this.files0);$.ajax(url : routePath + “/session/file/upload“,type : POST,data
4、: formData,processData : false,contentType : false,success : function(result) result = JSON.parse(result);if(result.code = “10000“)layer.msg(上传成功!);$(“#editHeadPortrait“).val(result.returnValue.filePath););响应例子:returnValue 里包含了 fileName 和 filePath3 字段管理-所属类型3.1新增所属类型请求地址:/session/fieldType/save请求参数参
5、数名 必填 字段类型 描述name 是 String 所属类型名称响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/save?name=13243434响应例子:“code“:“10000“,“exception“:null,“isSuccess“:true,“message“:“成功,系统处理正常!“,“page“:0,“pageSize“:0,“returnListSize“:0,“returnObject“:null,“return
6、Value“:null,“totals“:03.2修改所属类型请求地址:/session/fieldType/update请求参数参数名 必填 字段类型 描述id 是 Long 所属类型 idname 是 String 所属类型名称响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/update?id=2&name=test响应例子:“code“:“10000“,“exception“:null,“isSuccess“:true,“mess
7、age“:“成功,系统处理正常!“,“page“:0,“pageSize“:0,“returnListSize“:0,“returnObject“:null,“returnValue“:null,“totals“:03.3根据 id获取所属类型请求地址:/session/fieldType/getById请求参数参数名 必填 字段类型 描述id 是 Long 所属类型 id响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/getById?
8、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/fieldType/selectAll请求参数参数名 必填 字段类型 描述name 否 String 根据类型名称筛选响应code 10000 成功,-1 系统错误,10001 必
9、填参数为空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“:“145555“,“totals“:23.5删除所属类型(批量)请求地址:/sessio
10、n/fieldType/deleteByIds请求参数参数名 必填 字段类型 描述ids 是 List 所属类型 id 集合响应code 10000 成功,-1 系统错误,10001 必填参数为空message 响应描述result 如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/deleteByIds?ids=1响应例子:“code“:“10000“,“exception“:null,“isSuccess“:true,“message“:“成功,系统处理正常!“,“page“:0,“pageSize“:0,“returnListSize“:0,“returnObject“:null,“returnValue“:null,“totals“:0