From 9cb37291fc09bea8941ec279a901449d5b5715f0 Mon Sep 17 00:00:00 2001
From: zhl <zhl010101@gmail.com>
Date: Thu, 20 Apr 2023 15:28:35 +0800
Subject: [PATCH] update docs

---
 README.md    |  1 +
 docs/apis.md | 35 +++++++++++++++++++----------------
 2 files changed, 20 insertions(+), 16 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..142da61
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+# 网站活动相关接口
diff --git a/docs/apis.md b/docs/apis.md
index 5caf93a..412918d 100644
--- a/docs/apis.md
+++ b/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
+2. 如无特别说明, 以下接口的 Response 格式指的是 data 字段
+3. 接口名中带\*的表示, 需要验证 token, token 可以设置 header 的 Authorization: Bearer JWT_token, 或 Post body 的 token 字段, 或 Get 的 query token
 
 ```json
 {
@@ -32,9 +33,9 @@
 
 ### 2. 钱包登录
 
-客户端在获得钱包地址后,须先调用预登录方法获取nonce和tips, 然后调用钱包进行EIP-721签名.
+客户端在获得钱包地址后,须先调用预登录方法获取 nonce 和 tips, 然后调用钱包进行 EIP-721 签名.
 
-登录成功后返回的jwt需要保存至本地存储, 再次载入后, 可解析并获取exp字段, 判断当前token是否已经过期
+登录成功后返回的 jwt 需要保存至本地存储, 再次载入后, 可解析并获取 exp 字段, 判断当前 token 是否已经过期
 
 #### Request
 
@@ -60,9 +61,7 @@
 }
 ```
 
-
-### 3. *检查当前用户claim状态
-
+### 3. \*检查当前用户 claim 状态
 
 #### Request
 
@@ -75,15 +74,20 @@
 
 #### Response
 
-- 类型：对象
-- 属性：
-  - `account`（对象）：用户账户信息。
-  - `user`（对象）：认证用户的信息。
+```json
+[
+  {
+    "id": String,
+    "status": Number
+  }
+]
+```
 
-### 4. *用户申请claim
+status: 0: 不可以 claim, 1: 可 claim, 9: 已经 claim
 
-调用该方法后, 服务端会检查是否符合相关条件, 如果符合, 那么会立即返回一个taskId, 客户端需凭借此taskId轮询该任务的状态
+### 4. \*用户申请 claim
 
+调用该方法后, 服务端会检查是否符合相关条件, 如果符合, 那么会立即返回一个 taskId, 客户端需凭借此 taskId 轮询该任务的状态
 
 #### Request
 
@@ -101,8 +105,7 @@
 }
 ```
 
-### 5.* 检查claim任务的状态
-
+### 5.\* 检查 claim 任务的状态
 
 #### Request
 
@@ -120,7 +123,7 @@
 }
 ```
 
-status说明
+status 说明
 
 0: 队列中, 等待上链