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

发布时间:2020-04-13 12:04:34

版本控制信息

版本

日期

描述

作者

2018-8-13

创建

XXX

1 获取所有字段

1.1 获取所有字段

请求地址:/session/field/findAll

请求参数

参数名

必填

字段类型

描述

name

String

根据名称筛选

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:响应例子:{"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 文件上传

2.1 文件上传(ajax)

请求地址:/session/file/upload

请求参数

参数名

必填

字段类型

描述

file

FormData

FormData对象包含的文件

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子: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 }

}

});

响应例子:returnValue里包含了 fileName和filePath

3 字段管理-所属类型

3.1 新增所属类型

请求地址:/session/fieldType/save

请求参数

参数名

必填

字段类型

描述

name

String

所属类型名称

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:响应例子:{"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

Long

所属类型id

name

String

所属类型名称

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:&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

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:响应例子:{"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

String

根据类型名称筛选

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:响应例子:{"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

List

所属类型id集合

响应

code

10000成功,-1系统错误,10001必填参数为空

message

响应描述

result

如响应例子

请求例子:响应例子:{"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}

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

相关推荐