开发接口文档-API文档模板

XXX项目接口文档版本控制信息 版本 日期 描述 作者 V1.0 2018-8-13 创建 XXX 1获取所有字段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,"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"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}2文件上传2.1文件上传（ajax）请求地址：/session/file/upload请求参数 参数名 必填 字段类型 描述 file 是 FormData FormData对象包含的文件响应 code 10000成功，-1系统错误，10001必填参数为空 message 响应描述 result 如响应例子请求例子：varformData=newFormData(); 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和filePath3字段管理-所属类型3.1新增所属类型请求地址：/session/fieldType/save请求参数 参数名 必填 字段类型 描述 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,"returnValue":null,"totals":0}3.2修改所属类型请求地址：/session/fieldType/update请求参数 参数名 必填 字段类型 描述 id 是 Long 所属类型id name 是 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,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}3.3根据id获取所属类型请求地址：/session/fieldType/getById请求参数 参数名 必填 字段类型 描述 id 是 Long 所属类型id响应 code 10000成功，-1系统错误，10001必填参数为空 message 响应描述 result 如响应例子请求例子：http://127.0.0.1:8080/session/fieldType/getById?id=2响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2,"name":"re"},"totals":0}3.4获取所属类型列请求地址：/session/fieldType/selectAll请求参数 参数名 必填 字段类型 描述 name 否 String 根据类型名称筛选响应 code 10000成功，-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":"145555"}],"totals":2}3.5删除所属类型（批量）请求地址：/session/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}