接口文档规范

XXX接口说明书
(版本：
文档编号保密等级
作者最后修改日期
审核人最后审批日期
批准人最后批准日期
修订记录
日期版本修订说明修订人
1简介
1.1文档目的
接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。

本着快速高效开发的目的性，避免对接过程中的错误率。

1.2接口规范
(1) 遵循RESTful API设计风格
(2) 数据格式采用json格式
(3) 返回统一结构数据
例如：
结构：data（数据）、errorCode（状态码）、msg（提示信息）
{
data:{},
.] 订单列表
orderList orderId string 否订单id
orderName string 否订单名称
isStudent boolean 是false false 是否学生（是：true，否：
false）
返回参数：
参数名类型示例值默认值描述
data array […]返回的数据
data id string 用户id
gender number 1 1 用户性别（男：1，女：2）invoiceTitle string 抬头
address string 地址
billList array [...] 订单列表数据
billList id string 订单id
billName string 订单名称
billStauts number 1 1 订单状态（待开票：1，回款：
2，核销：3）
address string 客户地址
userInfo object {} 用户信息
userInfo name name 用户姓名
age number 用户年龄
gender string 1 1 用户性别（男：1，女：2）errorCode number 状态信息
msg string 信息提示
返回示例值:
{
data:[
{
id:'1',
gender:2,
invoiceTitle:'帝国快运',
address:'陕西省西安市雁塔区科技路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',
billName:'测试数据02',
billStauts:2,
address:'高新区'
}
],
userInfo:{
name:'张三',
age:23,
gender:1
}
}
],
errorCode:10001,
msg:''
}。