开发接口文档API文档模板

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

2、sSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":"types":null,"villages":null,"companys":"iconColour":"","iconSize":0,"iconSt

3、yle":"","id":4,"name":"XX","iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX","iconColour":"","iconSize":0,"iconStyle":&quo

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

5、);$.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.r

6、eturnValue.filePath););响应例子：returnValue里包含了 fileName和filePath3 字段管理-所属类型3.1 新增所属类型请求地址：/session/fieldType/save请求参数参数名必填字段类型描述name是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：:8080/session/fieldType/save?name=13243434响应例子："code":"10000",&q

7、uot;exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.2 修改所属类型请求地址：/session/fieldType/update请求参数参数名必填字段类型描述

8、id是Long所属类型idname是String所属类型名称响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：:8080/session/fieldType/update?id=2&name=test响应例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page

9、":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.3 根据id获取所属类型请求地址：/session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功，-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：:8080/session

10、/fieldType/getById?id=2响应例子："code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":"id":

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

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