update docs
This commit is contained in:
parent
3034702f3f
commit
9cb37291fc
27
docs/apis.md
27
docs/apis.md
@ -1,10 +1,11 @@
|
||||
# 徽章活动相关接口
|
||||
|
||||
### 说明
|
||||
|
||||
1. 通用返回格式, errcode=0 表示无错误
|
||||
|
||||
2. 如无特别说明, 以下接口的 Response 格式指的是 data 字段
|
||||
3. 接口名中带*的表示, 需要验证token, token可以设置header的Authorization: Bearer JWT_token, 或Post body的token字段, 或Get的query token
|
||||
3. 接口名中带\*的表示, 需要验证 token, token 可以设置 header 的 Authorization: Bearer JWT_token, 或 Post body 的 token 字段, 或 Get 的 query token
|
||||
|
||||
```json
|
||||
{
|
||||
@ -60,9 +61,7 @@
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### 3. *检查当前用户claim状态
|
||||
|
||||
### 3. \*检查当前用户 claim 状态
|
||||
|
||||
#### Request
|
||||
|
||||
@ -75,16 +74,21 @@
|
||||
|
||||
#### Response
|
||||
|
||||
- 类型:对象
|
||||
- 属性:
|
||||
- `account`(对象):用户账户信息。
|
||||
- `user`(对象):认证用户的信息。
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": String,
|
||||
"status": Number
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### 4. *用户申请claim
|
||||
status: 0: 不可以 claim, 1: 可 claim, 9: 已经 claim
|
||||
|
||||
### 4. \*用户申请 claim
|
||||
|
||||
调用该方法后, 服务端会检查是否符合相关条件, 如果符合, 那么会立即返回一个 taskId, 客户端需凭借此 taskId 轮询该任务的状态
|
||||
|
||||
|
||||
#### Request
|
||||
|
||||
- URL:`/api/user/claim`
|
||||
@ -101,8 +105,7 @@
|
||||
}
|
||||
```
|
||||
|
||||
### 5.* 检查claim任务的状态
|
||||
|
||||
### 5.\* 检查 claim 任务的状态
|
||||
|
||||
#### Request
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user