首页 > 代码库 > 圣熙女鞋API设计(一)

圣熙女鞋API设计(一)

女鞋API

数据结构定义

//Product
//产品数据对象解构
{
    id:101,
    name:‘产品名‘,
    summary:‘产品简介‘,
    image:‘imageURL‘,
    code:‘产品编码,例如3014‘,
    price:‘价格‘,
    colors:[
        color,
        ...
    ],
    sizes:[
        size,
        ...
    ]
}
//Color对象
//颜色描述对象
{
    id:‘颜色id,唯一标识‘,
    name:‘颜色名称,例如红色‘
}
//Size对象
//尺码描述对象
{
    id:‘尺码id,唯一标识‘,
    name:‘尺码名称,例如43号‘
}
//PreOrder
//预定信息
{
    id:101,
    date:‘时间‘,
    productID:
    name:‘产品名‘,
    code:‘产品编码,例如3014‘,
    image:‘图片链接‘,
    price:‘价格‘,
    count:‘数量,

}
//Order
//订单对象
{
    id:订单id,
    date:订单时间,
    totalPrice:总价,
    type:‘0为确认订单,1已确认订单,2已发货订单‘
}
//OrderDetail
//订单明细对象
{
    id:订单明细id,
    productID:商品类型ID,
    productName:商品名称,
    productCode:商品编码,
    productColorID:
    productColorName:
    productSizeID:
    productSizeName:
    count:
    price:
    totalPrice:
    type:‘订单明细类型,0正常,1退货申请中,2退货成功,3退货失败,4换货申请中,5换货成功,6退货失败‘
}
//BillDetail
//账单明细对象
{
    id:
    date:
    totalPrice:
    orderID:
}
//Bill
//对账单对象
{
    id:
    date:
    orderTotalPrice:订单总金额
    backTotalPrice:退货总金额
    money:应付账款
    type:‘0为确认,1已确认,2已付款‘
}
//notice
//通知对象
{
    id:
    title:
    content:
    date:
    type:‘0为公共,1为个人‘,
}

API接口定义

1,登录

请求地址:http://host:port/api/login

请求方式:POST

请求参数:

参数名参数说明
name 登录名
pwd 密码

返回值:

{
    success:true,
    data:{
        uid:1001
        token:xxxx
    }
}

2,获取商品

请求地址:http://host:port/api/getProducts

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌
type 0为全部商品,1为新品,默认为0

返回值:

{
    success:true,
    data:[
        Product对象,
        ...
    ]
}

3,提交预定信息

请求地址:http://host:port/api/postPreOrider

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
productID 商品ID
count 预定数量

返回值:

{
    success:true,
}

4,获取预定记录

请求地址:http://host:port/api/getPerOrders

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:[
        PreOrder对象,
        ...
    ]
}

5,获取订单列表

请求地址:http://host:port/api/getOrders

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:[
        Order对象,
        ...
    ]
}

6,获取订单明细

请求地址:http://host:port/api/getOrderDetails

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌
orderID 订单ID

返回值:

{
    success:true,
    data:[
        OrderDetail对象,
        ...
    ]
}

7,确认订单

请求地址:http://host:port/api/confirmOrder

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
orderID 确认订单ID

返回值:

{
    success:true,
}

8,退货

请求地址:http://host:port/api/backProduct

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
orderID 订单ID
orderDetailID 订单明细ID
count 退货数量

返回值:

{
    success:true,
}

9,换货

请求地址:http://host:port/api/changeProduct

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
orderID 订单ID
orderDetailID 订单明细ID
count 换货数量
colorID 换货颜色ID
sizeID 换货尺码ID

返回值:

{
    success:true,
}

10,获取账单明细

请求地址:http://host:port/api/getBillDetails

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:[
        账单明细对象,
        ...
    ]
}

11,获取对账单

请求地址:http://host:port/api/getBill

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:对账单对象,
}

12,确认对账单

请求地址:http://host:port/api/confirmBill

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
billID 对账单ID

返回值:

{
    success:true,
}

13,获取历史对账单

请求地址:http://host:port/api/getHistoryBills

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:[
        对账单对象,
        ...
    ],
}

14,获取通知

请求地址:http://host:port/api/getNotices

请求方式:GET

请求参数:

参数名参数说明
token 登录令牌

返回值:

{
    success:true,
    data:[
        通知对象,
        ...
    ],
}

15,修改密码

请求地址:http://host:port/api/user/setPassword

请求方式:POST

请求参数:

参数名参数说明
token 登录令牌
currentpwd 当前密码
newpwd 新密码

返回值:

{
    success:true,
}

圣熙女鞋API设计(一)