Browse Source

[u]更新文档

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

3
doc/README.md

@ -1,6 +1,6 @@
## 接口 ## 接口
| 接口名 | 请求方法 | 参数 | 返回值 | 备注 | | 接口名 | 请求方法 | 参数 | 返回值 | 备注 |
| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------- | | --------------- | -------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| /index | GET | | | | | /index | GET | | | |
| /run | GET | | {"status": 200, "msg": "success", "data": None} | 开始抽奖,进入抽奖状态 | | /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}]} | 获取抽奖结果,仅当抽奖状态才可调用此接口 | | /draw_lottery | GET | award_id=int | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "award_id":award_id, "role":role}]} | 获取抽奖结果,仅当抽奖状态才可调用此接口 |
@ -11,6 +11,7 @@
| /luckless_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_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} | 添加单个奖品 | | /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}} | 获取指定奖项信息 | | /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}]} | 获取所有奖项列表 | | /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} | 重置所有数据 | | /reset | GET | | {"status": 200, "msg": "success", "data": None} | 重置所有数据 |

Loading…
Cancel
Save