开发接口文档API文档模板
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
X X X项目接口文档版本控制信息
1获取所有字段
1.1获取所有字段
请求地址:/session/field/findAll
请求参数
响应
响应例子:{"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"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}
2文件上传
2.1文件上传(ajax)
请求地址:/session/file/upload
请求参数
响应
请求例子:var formData = new FormData();
("file", [0]);
$.ajax({
url : routePath + "/session/file/upload",
type : 'POST',
data : formData,
processData : false,
contentType : false,
success : function(result) {
result = (result);
if == "10000"){
('上传成功!');
}
}
});
响应例子:returnValue里包含了 fileName和filePath
3字段管理-所属类型
3.1新增所属类型
请求地址:/session/fieldType/save
请求参数
响应
响应例子:{"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
3.2修改所属类型
请求地址:/session/fieldType/update
请求参数
响应
响应例子:{"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
请求参数
响应
响应例子:{"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
请求参数
响应
响应例子:{"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
请求参数
响应
响应例子:{"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}