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

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

举报
开通vip

开发接口文档-API文档模板项目接口文档版本控制信息版本日期描述作者V1。02018-8—13创建XXX获取所有字段1.1获取所有字段请求地址:/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,"...

开发接口文档-API文档模板
项目接口文档版本控制信息版本日期描述作者V1。02018-8—13创建XXX获取所有字段1.1获取所有字段请求地址:/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}文件上传2.1文件上传(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字段管理-所属类型3.1新增所属类型请求地址:/session/fieldType/save请求参数参数名必填字段类型描述name是String所属类型名称响应code10000成功,—1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:。0.0.1:8080/session/fieldType/save?name=13243434响应例子:{"code"page":0,”pageSize":"10000",”exception”:null,”isSuccess”:true,"message:0,”returnListSize”:0,”returnObject”:null,"returnValue”:”成功,系统处理正常!”:null,”totals”:0}",”3.2修改所属类型请求地址:/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}3.3根据id获取所属类型请求地址:/session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功,—1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:http:。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获取所属类型列 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf 请求地址:/session/fieldType/selectAll请求参数参数名必填字段类型描述name否String根据类型名称筛选响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:。0.0。1:8080/session/fieldType/selectAll?name=1响应例子:{"code”:"10000","exception"page”:0,"pageSize”:0,”returnObject"6,"name”:”145555”}],"totals”:2}”:null,”isSuccess":true,"message":"成功,系统处理正常!”,:null,"returnValue”:[{"id":1,”name”:"123"},{"id”:3.5删除所属类型(批量)请求地址:/session/fieldType/deleteByIds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:。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}
本文档为【开发接口文档-API文档模板】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
个人认证用户
阳光花园
暂无简介~
格式:doc
大小:53KB
软件:Word
页数:6
分类:
上传时间:2022-07-09
浏览量:206