RESTful API - HelloYu/Restaurant-Management-System GitHub Wiki

Login

POST /login

data:{
	username:'admin',
	password:'admin'
}

成功

{
	status:200,
	user:{}   //一些客户端需要的用户信息
}

失败

{
	status:401, //http状态码
	result:""  //失败原因
}

postman测试

login_post_RMS

Users

POST /users

添加用户

{
	username:"",
	password:"",
	role:""
}

success

{
  "status": 200,
  "result": {
    "username": "test6",
    "password": "test6",
    "role": "chief",
    "_id": "5688afae3dfc1b9c151be3a1"
  }
}

GET /users or /users/:id

获取用户列表或单个用户详细信息。

{
  "status": 200,
  "result": [
    {
      "_id": "5688a92ada86fd0c0c9db35c",
      "username": "test2",
      "password": "test2",
      "role": "chief"
    },
    {
      "_id": "5688ae603a3cc1d02971f1f2",
      "username": "test6",
      "password": "test6",
      "role": "chief"
    }
  ]
}

id是用户在数据库表中的唯一标识。

PUT /users/:id

更新单个用户数据

DELETE /users/:id

删除单个用户

Roles

POST /roles

添加角色

data:{
	role:"",
}

role 是 ['chief','admin','waiter']中的一种，扩展性较差，暂定。应该根据不同的职责来创建角色。再给员工分配相应的角色，进行动态控制。

GET /roles or /roles/:id

获取角色列表或单个角色详细信息

return {
	id: {role:""},
	id1: {role:""}
}

例如：{1: {admin:"管理员"}}

PUT /roles/:id

更新单个角色数据

DELETE /roles/:id

删除单个角色

Menus

POST /menus

添加菜品

data:{
	menu_name:""
	menu_price:""
}

GET /menus or /menus/:id

获取菜品列表或单个菜品详细信息

return {
	id: {menu_name:"",menu_price:""},
	id1: {menu_name:"",menu_price:""}
}

id是菜品在数据库表中的唯一标识。