From 254d85223c69699794f0ac619708438cd35e070b Mon Sep 17 00:00:00 2001 From: luoning Date: Fri, 2 Feb 2018 14:58:52 +0800 Subject: [PATCH] =?UTF-8?q?[u]=201.=E5=A2=9E=E5=8A=A0=E8=8E=B7=E5=8F=96?= =?UTF-8?q?=E5=8D=95=E4=B8=AA=E5=A5=96=E5=93=81=E4=BF=A1=E6=81=AF=E7=9A=84?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3/award=EF=BC=9B2.=E7=AE=80=E5=8D=95=E6=8E=A5?= =?UTF-8?q?=E5=8F=A3=E4=BF=AE=E6=94=B9=E4=B8=BAget=E5=BD=A2=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/README.md b/doc/README.md index b1ff9d8..0c8a925 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,17 +1,18 @@ ## 接口 -| 接口名 | 请求方法 | 参数 | 返回值 | 备注 | -| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | -------------------------------- | -| /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} | 重置所有数据 | +| 接口名 | 请求方法 | 参数 | 返回值 | 备注 | +| --------------- | -------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------- | +| /index | GET | | | | +| /run | GET | 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, "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} | 添加新奖品 | +| /award | GET | award_id=int | {"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} | 重置所有数据 | ---