[关闭]
@Tean 2017-03-24T01:43:40.000000Z 字数 3120 阅读 1267

白菜帮API数据接口

api


所有接口均启用CORS跨域支持
接口环境:Node+MySQL
点击这里查看DEMO

一、用户注册接口

1. 接口地址:

  1. http://tean.wang:3005/register

2. 请求方式: post
3. 请求参数说明:

名称 类型 说明
name string 用户名,必需
pwd string 密码,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库连接异常; 202:用户名已存在; 203:注册失败)
  3. * result: 是否注册成功(true:成功; false:失败)
  4. */
  5. {code: 200, result: true}

二、用户登录接口

1. 接口地址:

  1. http://tean.wang:3005/login

2. 请求方式: post
3. 请求参数说明:

名称 类型 说明
name string 用户名,必需
pwd string 密码,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 201:用户名或密码错误)
  3. * result: 是否登录成功(true:成功; false:失败)
  4. * id: 登录成功后,该用户的id
  5. */
  6. {code: 200, result: true, id: 10000}

三、餐厅列表接口

1. 接口地址:

  1. http://tean.wang:3005/restaurant

2. 请求方式: get
3. 请求参数说明:
4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 204:暂无信息)
  3. * result: 是否查询成功(true:成功; false:失败)
  4. * data: 查询到的信息
  5. * id: 餐厅ID
  6. * name:餐厅名称
  7. * start:评价星数(1-5)
  8. * pc:人均消费
  9. * distance:距离(单位m)
  10. * pic:餐厅图片(http://tean.wang:3005/images/restaurant/xxx.jpg)
  11. */
  12. {
  13. "code":200,
  14. "result":true,
  15. "data":[
  16. {"id":1,"name":"美岸小镇","start":4,"pc":"46","distance":400,"pic":"3.jpg"},
  17. {"id":2,"name":"争鲜回转寿司","start":3,"pc":"50","distance":800,"pic":"1.jpg"},
  18. {"id":3,"name":"避风塘(市百一店)","start":4,"pc":"52","distance":675,"pic":"2.jpg"}
  19. ]
  20. }

四、餐厅详情接口

1. 接口地址:

  1. http://tean.wang:3005/restaurant_detail

2. 请求方式: get
3. 请求参数说明:

名称 类型 说明
id int 餐厅ID,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 205:暂无信息)
  3. * result: 是否查询成功(true:成功; false:失败)
  4. * data: 查询到的信息
  5. * id: 餐厅ID
  6. * name:餐厅名称
  7. * start:评价星数(1-5)
  8. * pc:人均消费
  9. * distance:距离(单位m)
  10. * pic:餐厅图片(http://tean.wang:3005/images/restaurant/xxx.jpg)
  11. * empty: 当前空桌
  12. * info:餐厅介绍
  13. * notice: 公告板
  14. */
  15. {
  16. "code":200,
  17. "result":true,
  18. "data":[
  19. {"id":1,"name":"美岸小镇","pc":"46","start":4,"pic":"3.jpg","distance":400,"empty":5,"notice":"8折","info":"雕爷牛腩餐厅..."}
  20. ]
  21. }

五、餐厅菜单接口

1. 接口地址:

  1. http://tean.wang:3005/foods

2. 请求方式: get
3. 请求参数说明:

名称 类型 说明
rid int 餐厅ID,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 206:暂无信息)
  3. * result: 是否查询成功(true:成功; false:失败)
  4. * data: 查询到的信息
  5. * id: 食物ID
  6. * rid:餐厅ID
  7. * name:名称
  8. * price:价格
  9. * pic:食物图片(http://tean.wang:3005/images/food/xxx.jpg)
  10. */
  11. {
  12. "code":200,
  13. "result":true,
  14. "data":[
  15. {"id":1,"rid":1,"name":"宫保鸡丁","price":35,"pic":"1.jpg"},
  16. {"id":2,"rid":1,"name":"土豆牛肉","price":48,"pic":"2.jpg"},
  17. {"id":3,"rid":1,"name":"没菜扣肉","price":45,"pic":"3.jpg"},
  18. {"id":4,"rid":1,"name":"干锅几块","price":55,"pic":"4.jpg"},
  19. ...
  20. ]
  21. }

六、用户订单列表接口

1. 接口地址:

  1. http://tean.wang:3005/order

2. 请求方式: get
3. 请求参数说明:

名称 类型 说明
uid int 用户ID,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常;)
  3. * result: 是否查询成功(true:成功; false:失败)
  4. * data: 查询到的信息
  5. * id: 订单ID
  6. * uid:用户ID
  7. * date:日期
  8. * info:订单中食物列表(json格式字符串)
  9. * price:价格
  10. * state:状态(有2种状态:未确定、已下单)
  11. */
  12. {
  13. "code":200,
  14. "result":true,
  15. "data":[
  16. {"id":2017031400001,"uid":1,"date":"2017-03-14T07:03:25.000Z","info":"[{\"name\":\"宫保鸡丁\",\"price\":35}]","state":"已下单"}
  17. ]
  18. }

七、添加订单接口

1. 接口地址:

  1. http://tean.wang:3005/add_order

2. 请求方式: post
3. 请求参数说明:

名称 类型 说明
uid int 用户ID,必需
data string 订单食物列表(JSON格式字符串),必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 208:添加失败)
  3. * result: 是否添加成功(true:成功; false:失败)
  4. * id: 添加的订单编号ID
  5. */
  6. {code: 200, result: true, id: 2015021200010}

八、提交订单接口

1. 接口地址:

  1. http://tean.wang:3005/submit_order

2. 请求方式: get
3. 请求参数说明:

名称 类型 说明
id int 订单ID,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 209:订单不存在)
  3. * result: 是否提交成功(true:成功; false:失败)
  4. */
  5. {code: 200, result: true}

九、取消订单接口

1. 接口地址:

  1. http://tean.wang:3005/cancel_order

2. 请求方式: get
3. 请求参数说明:

名称 类型 说明
id int 订单ID,必需

4. 返回示例:

  1. /**
  2. * code: 响应码(200:注册成功; -200:数据库链接异常; 210:订单不存在 | 已经提交的订单不能再取消)
  3. * result: 是否取消成功(true:成功; false:失败)
  4. */
  5. {code: 200, result: true}
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注