Browse Source

[u]更新文档

master
luoning 8 years ago
parent
commit
d1e6a44879
  1. 31
      doc/README.md

31
doc/README.md

@ -1,19 +1,20 @@ @@ -1,19 +1,20 @@
## 接口
| 接口名 | 请求方法 | 参数 | 返回值 | 备注 |
| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------- |
| /index | GET | | | |
| /run | GET | | {"status": 200, "msg": "success", "data": None} | 开始抽奖,进入抽奖状态 |
| /draw_lottery | GET | award_id=int | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "award_id":award_id, "role":role}]} | 获取抽奖结果,仅当抽奖状态才可调用此接口 |
| ~~/update~~ | ~~POST~~ | ~~[{"uid":string, "awards_id":int}]~~ | | ~~提交中奖用户~~ |
| /revoke | GET | uid=string | {"status": 200, "msg": "success", "data": None} | 取消用户中奖信息,uid为工号,例如G0001 |
| /lucky_users | GET | award_id=int | {"status": 200, "msg": "success", "data": {award_id:[{"uid":uid, "name":name, "role":role}]}} | 获取所有中奖用户列表,传入award_id获取指定奖项的中奖用户列表 |
| /users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "role":role}]} | 获取所有用户列表 |
| /luckless_users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "role":role}]} | 获取未中奖用户列表 |
| /add_awards | POST | [{"award_name":string, "award_capacity":int}] | {"status": 200, "msg": "success", "data": None} | 添加新奖品 |
| /add_award | GET | award_name=string& award_capacity=int | {"status": 200, "msg": "success", "data": None} | 添加单个奖品 |
| /award | GET | award_id=string | {"status": 200, "msg": "success", "data": {"award_id":award_id, "award_name":award_name, "award_capacity":award_capacity}} | 获取指定奖项信息 |
| /awards | GET | | {"status": 200, "msg": "success", "data": [{"award_id":award_id, "award_name":award_name, "award_capacity":award_capacity}]} | 获取所有奖项列表 |
| /reset | GET | | {"status": 200, "msg": "success", "data": None} | 重置所有数据 |
| 接口名 | 请求方法 | 参数 | 返回值 | 备注 |
| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| /index | GET | | | |
| /run | GET | | {"status": 200, "msg": "success", "data": None} | 开始抽奖,进入抽奖状态 |
| /draw_lottery | GET | award_id=int | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "award_id":award_id, "role":role}]} | 获取抽奖结果,仅当抽奖状态才可调用此接口 |
| ~~/update~~ | ~~POST~~ | ~~[{"uid":string, "awards_id":int}]~~ | | ~~提交中奖用户~~ |
| /revoke | GET | uid=string | {"status": 200, "msg": "success", "data": None} | 取消用户中奖信息,uid为工号,例如G0001 |
| /lucky_users | GET | award_id=int | {"status": 200, "msg": "success", "data": {award_id:[{"uid":uid, "name":name, "role":role}]}} | 获取所有中奖用户列表,传入award_id获取指定奖项的中奖用户列表 |
| /users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "role":role}]} | 获取所有用户列表 |
| /luckless_users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "role":role}]} | 获取未中奖用户列表 |
| /add_awards | POST | [{"award_name":string, "award_capacity":int}] | {"status": 200, "msg": "success", "data": None} | 添加新奖品 |
| /add_award | GET | award_name=string& award_capacity=int | {"status": 200, "msg": "success", "data": None} | 添加单个奖品 |
| /remove_award | GET | award_id=string | {"status": 200, "msg": "success", "data":None} | 如果奖品已经被抽取,则返回502,"data"为{"award_id": award_id} |
| /award | GET | award_id=string | {"status": 200, "msg": "success", "data": {"award_id":award_id, "award_name":award_name, "award_capacity":award_capacity}} | 获取指定奖项信息 |
| /awards | GET | | {"status": 200, "msg": "success", "data": [{"award_id":award_id, "award_name":award_name, "award_capacity":award_capacity}]} | 获取所有奖项列表 |
| /reset | GET | | {"status": 200, "msg": "success", "data": None} | 重置所有数据 |
---

Loading…
Cancel
Save