corgi/doc/api.md
2021-04-26 15:33:32 +08:00

78 lines
1.7 KiB
Markdown

# 答题游戏接口说明
## 一. 说明
所有接口均需上传sessionid
通用返回JSON结构, 接口Response的数据结构说明只包含data部分
``` JSON
{
"errcode": 0, //0:成功 2: 缺少必要参数(accountid, sessionid) 4: 帐号被封, 5: 帐号未找到 100: 所有未定义的错误
"errmsg": "", //错误描述
"data": {}, // 数据
}
```
## 二. 客户端接口列表
### 1. 获取关卡题目列表
1. Method: POST
2. URI: /api/:accountid/puzzle/list
| 字段 | 说明 |
| -------- | -------------------------------------- |
| accountid | 帐号id |
> POST参数
| 字段 | 说明 |
| -------- | -------------------------------------- |
| shop | 店铺id |
| level | 关卡id |
3. Response: JSON
```js
{
"id": "6080f330b9655b5c0467ee5e", // 题目id
"title": "“大丈夫为国捐躯,死而无憾!”这话是谁说的?", // 问题
"answers": [ // 可选答案
"刘铭传",
"徐骧",
"刘步蟾",
"刘永福"
],
"type": 1 // 题目类型 1: 普通的文字选择题, 2: 图形
}
```
### 1. 获取关卡题目列表
1. Method: POST
2. URI: /api/:accountid/puzzle/answer
| 字段 | 说明 |
| -------- | -------------------------------------- |
| accountid | 帐号id |
> POST参数
| 字段 | 说明 |
| -------- | -------------------------------------- |
| id | 题目id |
| level | 关卡id |
| answer | 回答的选项 |
3. Response: JSON
```js
{
result: 1 //答题结果 1: 正确, 0 : 错误
}
```