开发接口文档 API文档模板.doc

XXX项目接口文档 版本控制信息 版本 日期 描述 作者 2018-8-13 创建 XXX 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 参数名 必填 字段类型 描述 name 是 String 根据名称筛选 响应 code 系统错误，成功，10000-110001必填参数为空 message 响应描述 result 如响应例子 成功，系统处理正常！请求例子：响应例子：屻潣敤?????敜捸灥楴湯?畮汬尬獩畓捣獥屳琺畲?浜獥慳敧?,page:0,pageSize:0, eturnObject:null, eturnValue:{ ypes:null,villages:null,companys:[{iconColour:\,iconSize:0,icoconColour:\,iconSize:0,iconStyle:\,id:7, ame:XX}]}, otals:0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 参数名 必填 字段类型 描述 file 是 FormData FormData对象包含的文件 响应 code 必填参数为空10001成功，-1系统错误，10000 message 响应描述 result 如响应例子 请求例子：var formData = new FormData(); ( ile, [0]); $.ajax({ url : routePath + \/session/file/upload, type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = (result); if == @00){ (' 上传成功！'); $(#editHeadPortrait).val } } });响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 参数名 必填 字段类型 描述 name 是 String 所属类型名称 响应 code 成功，-1系统错误，必填参数为空1000110000 message 响应描述 result 如响应例子 请求例子：响应例子：屻潣敤?????敜捸灥楴湯?畮汬尬獩畓捣獥屳琺畲?浜獥慳敧?成功，系统处理正常！,page:0,pageSize:0, eturnListSize:0, eturnObject:null, eturnValue:null, otals:0} 修改所属类型 请求地址：/session/fieldType/update 请求参数 参数名 必填 字段类型 描述 id 是 Long 所属类型id name 是 String 所属类型名称 响应 code 必填参数为空1000110000成功，-1系统错误， message 响应描述 result 如响应例子 请求例子：&name=test 响应例子：屻潣敤?????敜捸灥楴湯?畮汬尬獩畓捣獥屳琺畲?浜獥慳敧?成功，系统处理正常！,page:0,pageSize:0, eturnListSize:0, eturnObject:null, eturnValue:null, otals:0} 根据id获取所属类型 请求地址：/session/fieldType/getById 请求参数 参数名 必填 字段类型 描述 id 是 Long id所属类型 响应 code 必填参数为空10001系统错误，-1成功，10000 message 响应描述 result 如响应例子 成功，系统处理正常！屻潣敤?????敜捸灥楴湯?畮汬尬獩畓捣獥屳琺畲?浜獥慳敧?请求例子：响应例子： ,page:0,pageSize:0, eturnListSize:0, eturnObject:null, eturnValue:{id:2, ame: e}, otals:0} 获取所属类型列表 /session/