一个简化的订单系统的接口文档

开发目的

为了练习MySQL的操作和Redis操作。以及在业务开发中设计模式的练习。
在本次练习中直接裁剪用户系统。以刷入模拟用户数据的方式进行简化。

接口格式采用REST的格式进行定义。

接口定义

添加订单

URL： /order 
METHOD POST
REQUEST BODY
{
  "good_id":"", // 商品ID格式定义UUID
  "quantity":1, // 商品数量
  "amount":1,   // 订单总额
  "user_id":""  // 用户ID
}
RESPONSE BODY
{
  "order_id":"" // 订单号格式定义UUID
}
RESPONSE CODE:
200 完成
410 重复下单，商品名，和商品数量在一天内重复下订单。
411 库存不足

查询用户的所有订单

URL /order/user/{user_id}
METHOD GET
REQUEST BODY
RESPONSE BODY
{
  "from": 1,       // 结果起始位置
  "size": 10000,   // 结果总数
  "limit": 5,      // 本页长度
  "order": [
    {
      "good_id": "",
      "quantity": 1,
      "amount": 1,
      "order_id": ""
    }
  ]
}
RESPONSE CODE
使用标准HTTP定义

查询某个订单

URL /order/{order_id}
METHOD GET
REQUEST BODY
RESPONSE BODY
{
  "good_id": "",
  "quantity": 1,
  "amount": 1,
  "user_id": ""
}
RESPONSE CODE
使用标准HTTP定义

修改某个ORDER

URL /order/{order_id}
METHOD PUT
REQUEST BODY
{
  "order_id": "", // 查询主键
  "good_id": "",  // 可修改内容
  "quantity": 1,  // 可修改内容
  "amount": 1     // 可修改内容
}
RESPONSE BODY
RESPONSE CODE
使用标准HTTP定义
例如：
200 修改成功
404 未找到订单
403 订单不属于提出修改订单用户或管理员
401 未登录
50x 服务器错误