api接⼝⽂档html模板,开发接⼝⽂档-api⽂档模板
1、XXX项⽬接⼝⽂档版本控制信息版本⽇期描述作者V1.02018-8-13创建XXX1 获取所有字段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
2、,id:7,name:XX,totals:02 ⽂件上传2.1 ⽂件上传(ajax)请求地址:/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData对象包含的⽂件响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例⼦请求
例⼦:var formData = new FormData();formData.append(file, this.files0);$.ajax(url : routePath + /session/file/upload,type :
POST,data : formData,processData : false,contentType : false,success : function(result) result =
JSON.parse(result);de = 10000)layer.msg(上传成功!);$(#editHeadPortrait).urnValue.filePath););响。
3、应例⼦:returnValue⾥包含了 fileName和filePath3 字段管理-所属类型3.1 新增所属类型请求地址:/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:03.2 修改所属类型请求地
百度api接口址:/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称响应code10000成
功,-1系统错误,10001必填参数为空messag。
4、e响应描述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:03.3 根据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,returnList。
5、Size:0,returnObject:null,returnValue:id:2,name:re,totals:03.4 获取所属类型列表请求地址:/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:23.5 删除所属类型(批量)请求地
址:/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。
《开发接⼝⽂档-api⽂档模板》由会员⼩**分享,可在线阅读,更多相关《开发接⼝⽂档-api⽂档模板》请在⾦锄头⽂库上搜索。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论