当前位置：文档之家 › 开发接口文档-API文档模板

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

  • 格式：doc
  • 大小：93.00 KB
  • 文档页数：5

下载文档原格式

  / 5
  1. 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

XXX项目接口文档

版本控制信息

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

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字段管理-所属类型

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}

【下载本文档，可以自由复制内容或自由编辑修改内容，更多精彩文章，期待你的好评和关注，我将一如既往为您服务】

相关主题