admin 管理员组文章数量: 1184232
2024年3月22日发(作者：littlevgl源码下载)
.
XXX项目接口文档
版本控制信息
版本
V1.0
日期
2018-8-13
创建
描述 作者
XXX
1 获取所有字段
1.1 获取所有字段
请求地址：/session/field/findAll
请求参数
参数名
name
响应
code
message
result
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
必填
是
字段类型
String
描述
根据名称筛选
请求例子：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"},{"icon
Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}
'.
.
2 文件上传
2.1 文件上传（ajax）
请求地址：/session/file/upload
请求参数
参数名
file
响应
code
message
result
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
必填
是
字段类型 描述
FormData FormData对象包含的文件
请求例子：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"){
}
('上传成功！');
$("#editHeadPortrait").val(th);
响应例子：returnValue里包含了 fileName和filePath
3 字段管理-所属类型
3.1 新增所属类型
请求地址：/session/fieldType/save
请求参数
参数名 必填 字段类型 描述
'.
.
name
响应
code
message
result
是 String 所属类型名称
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
请求例子：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
name
响应
code
message
result
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
必填
是
是
字段类型
Long
String
描述
所属类型id
所属类型名称
请求例子：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
响应
code
message
10000成功，-1系统错误，10001必填参数为空
响应描述
必填
是
字段类型
Long
描述
所属类型id
'.
.
result 如响应例子
请求例子：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
响应
code
message
result
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
必填
否
字段类型
String
描述
根据类型名称筛选
请求例子：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
响应
code
message
result
10000成功，-1系统错误，10001必填参数为空
响应描述
如响应例子
必填
是
字段类型
List
描述
所属类型id集合
请求例子：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文档模板 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://roclinux.cn/p/1711098550a588387.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论