接口文档规范

XXX 接口说明书(版本：V1.0)修订记录日期版本修订说明修订人文 档 编 号保 密 等 级作 者最后修改日期审 核 人最后审批日期批 准 人最后批准日期1简介1.1 文档目的 接口文档是前端与后端交互密不可分的环节，接口的法律规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避开对接过程中的错误率。1.2 接口法律规范(1) 遵循 RESTful API 设计风格(2) 数据格式采纳 json 格式(3) 返回统一结构数据例如：结构：data（数据）、errorCode（状态码）、msg（提醒信息） { data: {}, // 数据类型不一定为 object 类型 errorCode: 10001, msg: '' } (4) 枚举型参数应列举参数所有值及说明例如：gender：性别（男：1，女：2） userInfo: { name: '张三', age: 23, gender: 1 }(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如：billList: 账单列表(父级) billList: [ { id: '001', billName: '测试数据', billStauts: 1, address: '雁塔区' } ](6) 返回参数数据类型保持一致性例如：billList: 账单列表（有数据） billList: [ { id: '001', billName: '测试数据', billStauts: 1, address: '雁塔区' } ]billList: 账单列表（无数据） billList: []返回的参数数据类型都为：array(7) 下拉及选择型数据以键值对的形式返回例如：orderOperate：订单操作 orderOperate: [ { label: '待开票' value: 1001}, { label: '回款' value: 1003 } ](8) “操作类型”的接口必须返回 msg 信息内容(9) 返回的展示型数据应具有可用性例如：createTime：生成时间（建议格式）{ createTime: '2025-8-20 17:00:00'}建议：由于前台解决数据能力较弱，故后台返回的数据尽也许便于前台使用。2接口定义2.1 特别接口2.1.1猎取服务器 sessionKey接口标记：接口地址：请求方式：POST请求参数：参数名类型必填示例值默认值描述appTypenumber是111:e 站,2:客户codestring否wx.login 返回的 code输出参数：参数名类型示例值默认值描述errorCodenumber100100:成功,-99:失败,-10:需要登录 -20:Session 失效msgstring接口返回的文字消息datastringApi 接口返回 session 值返回示例值: { data: '123456', errorCode: 100, msg: '' } 2.2 通用接口2.2.1账单列表接口标记：接口地址：请求方式：POST请求参数：参数名类型必填示例值默...