Uphall is a simple app of dinner management ,and this repo is the server of the app, it can make cook(or worker for hall) to publish the infos of foods ,and people want to have a meal in hall can order the food that she/he want to eat refrain from the long queue. Read the restful api references for more details
$ git clone git@github.com:leftjs/uphall.git
$ cd uphall/
$ npm install -g gulp
$ npm install
$ gulp build (for test)
$ gulp (for serve)访问除login/register两个api外的api均需要在headers中传入'x-token'以判断用户身份，不传一律拒绝操作，返回401
-
用户注册
description: 为用户提供注册功能
url: /api/users/register
method:POST
params:
- username: [required,unique,string] 用户名
- password: [required,string] 密码
- is_admin: [optional,boolean,default=false] 判断用户是否是管理员的标志位，慎传属性，管理员具有最高权限
- is_windower: [optional,boolean,default=false] 判断用户是否是窗口服务员的标志位
return:
- 404（具体错误原因参照返回err中的message，以下401为未授权错误，主要是用户不是当前所允许的用户，或者token未传、400未自定义错误，主要是对应功能操作失败后的返回、404主要为资源未找到错误，大多数场景是需求参数传错或者未传或者是url访问出错，500为服务器错误，请将错误原因issues，以便及时修正，以后各错误类型均如此，在此不再赘述）
- 200 {id: 用户的id}
-
用户登录
description:为用户提供登录的功能
url: /api/users/login
method: POST
params:
- username: [required,string] 用户名
- password: [required,string] 密码
return:
- 400
- 200 {token:登录成功的标志，以后每次访问均要携带以判断用户身份,expiredTime:token的有效期(默认为7天）
-
更新用户信息
description: 提供用户信息更新的api
url: /api/users/:id
method:PUT
headers:
- x-token: [required] !!! 用户token 该参数每次必传，以下不再赘述
params:
- id:[required,query,string] 需要更新的用户的id
- name: [optional,string] 用户昵称
- password: [optional,string] 用户新密码
- is_admin:[optional,boolean] 提升为管理员
- is_windower:[optional,boolean] 提升为窗口服务员
return:
- 400/404
- 200 {true}
-
用户信息的获取
description: 获取指定用户的信息
url: /api/users/:id
method: GET
params:
- id:[required,query] 用户的id
return
- 404
- 200 {name:昵称,is_windower:是否是窗口服务员，avatar_uri:头像链接，score:积分}
-
添加一个窗口
description: 添加一个窗口，未传的属性用默认值填充
url:/api/windows/
method: POST
params:
- windowName:[optional,string] 窗口名称
- address: [optional,string] 地址(example:1楼红椅区12号窗)
- type:[optional,string]贩卖类型( 综合、点餐、快餐等等）
- shopping_breakfast: [optional,boolean] 是否卖早饭
- shopping_lunch: [optional,boolean] 是否卖中饭
- shopping_dinner: [optional,boolean] 是否卖晚饭
- description: [optional,string] 窗口描述
- bulletin: [optional,string] 窗口公告
- promotion: [optional,string] 优惠信息
return:
- 404
- 200 {msg:'添加成功',id: 商店的id}
-
获取一个窗口
description: 获取指定窗口信息
url: /api/windows/:id
method:GET
params:
- id: [required,query] 窗口id
return:
- 404
- 200 {window: 窗口信息（属性过多，不再赘述）}
-
更新一个窗口
description:更新指定窗口信息，当前用户必须是管理员身份或者窗口所有者
url: /api/windows/:id
method:PUT
params:
- windowName:[optional,string] 窗口名称
- address: [optional,string] 地址(example:1楼红椅区12号窗)
- type:[optional,string]贩卖类型( 综合、点餐、快餐等等）
- shopping_breakfast: [optional,boolean] 是否卖早饭
- shopping_lunch: [optional,boolean] 是否卖中饭
- shopping_dinner: [optional,boolean] 是否卖晚饭
- description: [optional,string] 窗口描述
- bulletin: [optional,string] 窗口公告
- promotion: [optional,string] 优惠信息
- resting: [optional,boolean] 是否休息中
- icon:[optional,string] 窗口图标
return:
- 404/401/400
- 200 {true}
-
删除一个窗口
description:删除指定id的窗口，当前用户必须是管理员或者窗口所有者
url: /api/windows/:id
method: DELETE
return:
- 400/404/401
- 200 {true}
-
获取所有窗口
description: 获得数据库中所有窗口的信息
url: /api/windows/
method: GET
return:
- 404
- 200 [{windowObj},{windowObj},...]
-
获取某个条件下的所有窗口
description: 传入指定的query param，返回符合条件的窗口
url: /api/windows/conditions
method: POST
params:
- type:[optional,string] 窗口类型，没有采用枚举，类型字符串可以自由发挥，但需要注意的是匹配，匹配，匹配！！！
- shopping_breakfast:[optional,boolean]
- shopping_lunch: [optional,boolean]
- shopping_dinner:[optional,boolean]
- resting: [optional,boolean]
return:
- 404
- 200 [{windowObj},{windowObj},...]
-
添加一个食物
description: 添加一个食物到指定的窗口
url: /api/foods/:id
method:POST
params:
- name:[optional,string] 食物名称
- price: [optional,number] 食物价格
- number:[optional,number] 食物的余量
- type:[optional,string] 食物的类型 如：小炒，饮料等等，未用枚举，自己控制，记得匹配！！！！
- norms: [optional,string] 食物的规格 如: 五分熟 ，超辣 等等 未用枚举，自己控制，记得匹配！！！！
- is_breakfast:[optional,boolean] 属于早餐
- is_lunch: [otpional,boolean] 属于中餐
- is_dinner: [optional,boolean] 属于晚餐
return:
- 404/401
- 200 {id:食物id}
-
获取一个食物
description: 通过食物id获得指定食物信息
url: /api/foods/:id
method:GET
params:
- id: [required,query] 食物id
return:
- 404
- 200 {foodObj}
-
更新一个食物
description: 更新一个食物，允许参数为新增一个food时的参数
url: /api/foods/:id
method:PUT
params:
- name:[optional,string] 食物名称
- price: [optional,number] 食物价格
- number:[optional,number] 食物的余量
- type:[optional,string] 食物的类型 如：小炒，饮料等等，未用枚举，自己控制，记得匹配！！！！
- norms: [optional,string] 食物的规格 如: 五分熟 ，超辣 等等 未用枚举，自己控制，记得匹配！！！！
- is_breakfast:[optional,boolean] 属于早餐
- is_lunch: [otpional,boolean] 属于中餐
- is_dinner: [optional,boolean] 属于晚餐
- icon: [optional,string] 图片url
return:
- 404/401
- 200 {id: 食物id}
-
删除一个食物
description: 删除指定食物的记录，注意权限问题，只有窗口所有者能删除自己的food
url: /api/foods/:id
method:DELETE
params:
- id: [required,query] 食物id
return:
- 404/401/400
- 200 {true}
-
获取某个窗口的所有食物
description: 根据传入的窗口id，获取该窗口的所有食物
url: /api/foods/list/:id
method:GET
params:
- id: [required,query] 窗口id
return:
- 404
- 200 [{foodObj},{foodObj},...]
-
添加一个订单
description: 添加订单，需要指定窗口id
url: /api/orders/:id
method:POST
params:
- id:[required,query] 窗口id
- [{item:foodId1,count:5},{item:foodId2,count:3},…]:[required,array] 传入object数组，其中item的值为食品的id，count为购买的数量
return
- 404/401/400
- 200 {id:订单号}
-
获取一个订单
description:通过指定的订单id获取一个订单
url: /api/orders/:id
method:GET
params:
- id:[required,query] 订单id
return
- 404/401
- 200 {orderObj}
-
更新一个订单
description: 通过传入指定参数更新订单信息，用户信息通过token认证，窗口服务员可以接单（has_received),完成订单(has_done)，消费者可以取消订单(is_cancel)
url: /api/orders/:id
method:PUT
params:
- id:[required,query] 订单id
- has_received: [optional,boolean] 接单为窗口服务员所拥有权限，其余类型的用户设置均无效，下同
- has_done: [optional,boolean] 更新订单状态为完成状态
- is_cancel:[optional,boolean] 消费者可以设置取消订单属性
return:
- 404/401/400
- 200 {true}
-
发表评价
description: 传入订单id 发表相应的评价，消费者评价可以上传图片，窗口管理员评价不需要传入图片，图片上传有两种方式，暂时不支持客户端自行上传到云数据库而只传递url到服务器，目前是调用上传部分的api进行图片上传到本服务器的操作，这点请注意一下
url: /api/comments/:id
method: POST
params:
- id [required,query] 订单id
- rating: [required,number(0.0~5.0)] 评分
- content: [optional,string] 评价内容，可以不传使用默认评价
return:
- 404/400
- 200 {id:评价的id}
-
获取窗口的评价
description: 获取指定窗口的评价，包括消费者和窗口管理员的评价
url: /api/comments/window/:id
method: GET
params:
- id: [required,query] 窗口id
return:
- 404
- 200 [{commentObj},{commentObj},...]
-
获取单个订单的评价
descripiton: 获取单个订单的双方评价
url: /api/comments/order/:id
method: GET
params:
- id: [required,query] 订单id
return:
- 404
- 200 [{commentObj},{commentObj},…]
-
窗口的icon上传
description: 窗口的icon的上传，身份认证必须是该窗口的拥有者
headers:
- Content-Type: multipart-form-data 除上传api外都默认是application/x-www-form-urlencoded
- x-token: 默认必传
url: /api/upload/window/:id
method: POST
params:
- id: [required,query] 窗口的id
- file: [required,file] 可以传入一张image，大小不超过200K，不限制属性名
return:
- 400/401
- 200 body.text = 'success'
-
评论的图片上传
description: 某订单评论的图片上传，必须是该订单的消费者
headers:
- Content-Type: multipart-form-data 除上传api外都默认是application/x-www-form-urlencoded
- x-token: 默认必传
url: /api/upload/comment/:id
method: POST
params:
- id: [required,query] 订单的id
- files: [required,file] 可以传入多张图片，注意属性名不能相同，可用file1,file2... 代替，不限制属性名，可自由发挥
return
- 400/401
- 200 body.text = 'success'
-
用户头像上传
description: 用户头像的上传
headers:
- Content-Type: multipart-form-data 除上传api外都默认是application/x-www-form-urlencoded
- x-token: 默认必传
url: /api/upload/avatar
method: POST
params:
- file: [required,file] 文件名称无所谓，只需要传递一张图片即可，大小不超过200K
return:
- 400
- 200 body.text = 'success'
-
食物的展示图片上传
description: 食物的展示图片的上传，图片最大尺寸为1M，规定自由该食物的拥有者能够上传食物的图片
headers:
- Content-Type: multipart-form-data 除上传api外都默认是application/x-www-form-urlencoded
- x-token: 默认必传
url: /api/upload/food/:id
method: POST
params:
- id: [required,query] 食物的id
- file: [required,file] 可以传入一张image，大小不超过200K，不限制属性名
return:
- 400/401
- 200 body.text = 'success'
api(v1)如上，其余功能v2中陆续增加，推送以及IM拟采用leancloud,文档可以提前阅读
MIT