diff --git a/doc/README.md b/doc/README.md index bb0ab36..b1ff9d8 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,17 +1,17 @@ ## 接口 -| 接口名 | 请求方法 | 参数 | 备注 | -| --------------- | -------- | ---------------------------------------- | -------------------------------- | -| /index | GET | | | -| /run | POST | {"award_id":int} | 开始抽奖 | -| /draw_lottery | GET | | 获取抽奖结果,仅当抽奖状态才可调用此接口 | -| ~~/update~~ | ~~POST~~ | ~~[{"uid":string, "awards_id":int}]~~ | ~~提交中奖用户~~ | -| /revoke | POST | {"uid":string} | 取消用户中奖信息,uid为工号,例如G0001 | -| /lucky_users | GET/POST | {"awards_id":int} | 获取所有中奖用户列表,使用post方式获取指定奖项的中奖用户列表 | -| /users | GET | | 获取所有用户列表 | -| /luckless_users | GET | | 获取未中奖用户列表 | -| /add_awards | POST | [{"award_id":int, "award_name":string,"award_capacity":int}] | 添加新奖品 | -| /awards | GET | | 获取所有奖项列表 | -| /reset | GET | | 重置所有数据 | +| 接口名 | 请求方法 | 参数 | 返回值 | 备注 | +| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | -------------------------------- | +| /index | GET | | | | +| /run | POST | {"award_id":int} | {"status": 200, "msg": "success", "data": None} | 开始抽奖,进入抽奖状态 | +| /draw_lottery | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name, "award_id":award_id}]} | 获取抽奖结果,仅当抽奖状态才可调用此接口 | +| ~~/update~~ | ~~POST~~ | ~~[{"uid":string, "awards_id":int}]~~ | | ~~提交中奖用户~~ | +| /revoke | POST | {"uid":string} | {"status": 200, "msg": "success", "data": None} | 取消用户中奖信息,uid为工号,例如G0001 | +| /lucky_users | GET/POST | {"award_id":int} | {"status": 200, "msg": "success", "data": {award_id:[{"uid":uid, "name":name}]}} | 获取所有中奖用户列表,使用post方式获取指定奖项的中奖用户列表 | +| /users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name}]} | 获取所有用户列表 | +| /luckless_users | GET | | {"status": 200, "msg": "success", "data": [{"uid":uid, "name":name}]} | 获取未中奖用户列表 | +| /add_awards | POST | [{"award_id":int, "award_name":string,"award_capacity":int}] | {"status": 200, "msg": "success", "data": None} | 添加新奖品 | +| /awards | GET | | {"status": 200, "msg": "success", "data": [{"award_id":award_id, "award_name":award_name}]} | 获取所有奖项列表 | +| /reset | GET | | {"status": 200, "msg": "success", "data": None} | 重置所有数据 | ---