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

XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX获取所有字段获取所有字段请求地址：/session/field/findAll请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功，-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}文件上传文件上传（ajax）请求地址：/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData对象包含的文件响应code10000成功，-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和filePath字段管理-所属类型新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述name是String所属类型名称响应code10000成功，-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}修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称响应code10000成功，-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}根据id获取所属类型请求地址：/session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功，-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}获取所属类型列表请求地址：/session/fieldType/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":"145555"}],"totals":2}删除所属类型（批量）请求地址：/session/fieldType/deleteByIds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code10000成功，-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}