开发接口文档-API文档模板参考范本.docxVIP

精品文档交流 精品文档交流 XXX 项目接口文档 版本控制信息 版本 日期 描述 作者 V1.0 2018-8-13 创建 XXX 获取所有字段 获取所有字段 请求地址： /session/field/findAll 请求参数 参数名 必填 字段类型 描述 name 是 String 根据名称筛选 响应 code 10000 成功， -1 系统错误， 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子： :8080/session/field/findAll?name=X 响应例子： {code:10000,exception:null,isSuccess:true,message: 成功，系统处理正常！ ,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},{icon Colour:,iconSize:0,iconStyle:,id:7,name:XX}]},totals:0} 文件上传 文件上传（ ajax ） 请求地址： /session/file/upload 请求参数 参数名 必填 字段类型 描述 file 是 FormData FormData 对象包含的文件 响应 code 10000 成功， -1 系统错误， 10001 必填参数为空 message 响应描述 result 如响应例子 请 求 例 子 ： var formData = new FormData(); formData.append(file, this.files[0]); $.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.returnValue.filePath); } } }); 响应例子： returnValue 里包含了 fileName 和 filePath 字段管理 - 所属类型 新增所属类型 请求地址： /session/fieldType/save 请求参数 参数名 必填 字段类型 描述 name 是 String 所属类型名称 响应 code 10000 成功， -1 系统错误， 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子： :8080/session/fieldType/save?name响应例子： {code:10000,exception:null,isSuccess:true,message: 成功，系统处理正常！ ,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:0} 修改所属类型 请求地址： /session/fieldType/update 请求参数 参数名 必填 字段类型 描述 id 是 Long 所属类型 id name 是 String 所属类型名称 响应 code 10000 成功， -1 系统错误， 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子： :8080/session/fieldType/update?id=2name=test 响应例子： {code:10000,exception:null,isSuccess:true,message: 成功，系统处理正常！ ,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:0} 根据 id 获取所属类型 请求地址： /session/fieldType/getById 请求参数 参数名 必填 字段类型 描述 id 是 Long 所属类型 id 响应 code 10000 成功， -1 系统错误， 10001 必填参数为空 message