开发接口文档-API文档模板教学内容.docVIP

XXX项目接口文档 版本控制信息 版本 日期 描述 作者 V1.0 2018-8-13 创建 XXX 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 参数名 必填 字段类型 描述 name 是 String 根据名称筛选 响应 code 10000成功，-1系统错误，10001必填参数为空 message 响应描述 result 如响应例子 请求例子：: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},{iconColour:,iconSize:0,iconStyle:,id:7,name:XX}]},totals:0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 参数名 必填 字段