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

1、XXX项目接口文档版本控制信息版本日期描述作者2018-8-13创建XXX1 获取所有字段1.1获取所有字段请求地址：/session/field/findAII请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正

2、常!","page":0,"pageSize":0,"returnObject":null,"returnValue":"types":null,"villages":null,"companys":"iconCo lour":"","iconSize":0,"iconStyle":"","id":4,"name&qu

3、ot;:"XX","iconColour":"","iconSize":0,"iconStyle":"","id":5 ,"name":"XX","iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX&

4、quot;,"totals":02 文件上传2.1文件上传（ajax ）请求地址：/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData对象包含的文件响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子： var formData = new FormData();("file", 0);$.ajax(url : routePath + "/session/file/upload".type : 'POST

5、',data : formData,processData : false,contentType : false,success : function(result) result = (result);if = "10000")('上传成功！');$("#editHeadPortrait").val);响应例子：returnValue 里包含了 fileName 和 filePath3 字段管理-所属类型3.1新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述name是Strin

6、g所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":n

7、ull,"returnValue":null,"totals":03.2修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：&name=test响应例子："code":"10000","exception":null,"isSuccess":t

8、rue,"message":"成功，系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.3根据id获取所属类型请求地址：/session/fieldType/getByld 请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功，-1系统错误，10001必填参数

9、为空message响应描述result如响应例子请求例子：响应例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":"id&

10、quot;:2,"name":"re","totals":03.4获取所属类型列表请求地址：/session/fieldType/selectAll请求参数参数名必填字段类型描述name否String根据类型名称筛选响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：响应例子："code":"10000","exception":null,"isSuccess":true,"mes

11、sage":"成功，系统处理正常!","page":0,"pageSize":0,"returnObject":null,"returnValue":"id":1,"name":"123","id":6,"name":"145555","totals":23.5删除所属类型（批量）请求地址：/session/fieldType/deleteBylds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code|10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子成功，系统处理正常!请求例子：响应例子："code":"10000","exception":null,"isSuccess":true,