接口文档规范_第1页
接口文档规范_第2页
接口文档规范_第3页
接口文档规范_第4页
接口文档规范_第5页
已阅读5页,还剩4页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

1、xxx接口说明PAGE xxx接口文档XXX接口说明书(版本:V1.0)文 档 编 号保 密 等 级作 者最后修改日期审 核 人最后审批日期批 准 人最后批准日期修订记录日期版本修订说明修订人简介文档目的 接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。接口规范(1) 遵循RESTful API设计风格(2) 数据格式采用json格式(3) 返回统一结构数据例如:结构:data(数据)、errorCode(状态码)、msg(提示信息) data: , / 数据类型不一定为object类型 errorCo

2、de: 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, a

3、ddress: 雁塔区 billList: 账单列表(无数据) billList: 返回的参数数据类型都为:array(7) 下拉及选择型数据以键值对的形式返回例如:orderOperate:订单操作 orderOperate: label: 待开票 value: 1001, label: 回款 value: 1003 (8) “操作类型”的接口必须返回msg信息内容(9) 返回的展示型数据应具有可用性例如:createTime:生成时间(建议格式) createTime: 2018-8-20 17:00:00建议:由于前台处理数据能力较弱,故后台返回的数据尽可能便于前台使用。接口定义特殊接口

4、获取服务器sessionKey接口标识:接口地址:/api/GetSessionKey请求方式:POST请求参数:参数名类型必填示例值默认值描述appTypenumber是111:e站,2:客户codestring否wx.login返回的code输出参数:参数名类型示例值默认值描述errorCodenumber100100:成功,-99:失败,-10:需要登录 -20:Session失效msgstring接口返回的文字消息datastringApi接口返回session值返回示例值: data: 123456, errorCode: 100, msg: 通用接口账单列表接口标识:接口地址:/a

5、pi/billList请求方式:POST请求参数:参数名类型必填示例值默认值描述idnumber是订单idsortstring否排序gendernumber是11性别(男:1,女:2)orderListarray否.订单列表orderList orderIdstring否订单idorderNamestring否订单名称isStudentboolean是falsefalse是否学生(是:true,否:false)返回参数:参数名类型示例值默认值描述dataarray返回的数据dataidstring用户idgendernumber11用户性别(男:1,女:2)invoiceTitlestring

6、抬头addressstring地址billListarray.订单列表数据billListidstring订单idbillNamestring订单名称billStautsnumber11订单状态(待开票:1,回款:2,核销:3) addressstring客户地址userInfoobject用户信息userInfonamename用户姓名agenumber用户年龄genderstring11用户性别(男:1,女:2)errorCodenumber状态信息msgstring信息提示返回示例值: data: id: 1, gender: 2, invoiceTitle: 帝国快运, address

7、: 陕西省西安市雁塔区科技路24号, billList: id: 001, billName: 测试数据, billStauts: 1, address: 雁塔区 , id: 002, billName: 测试数据02, billStauts: 1, address: 高新区 , userInfo: name: 张三, age: 23, gender: 1 , id: 2, gender: 1, invoiceTitle: 圆通快递, address: 陕西省西安市雁塔区科技路24号, billList: id: 003, billName: 测试数据, billStauts: 1, address: 雁塔区 , id: 004,

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论