From 80e20893ca29617a10f54ccaab62c3c9e91739cd Mon Sep 17 00:00:00 2001 From: Yesterday17 Date: Sun, 12 Dec 2021 23:34:45 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E7=89=B9=E6=80=A7=EF=BC=9A=E9=82=AE?= =?UTF-8?q?=E7=AE=B1=E9=AA=8C=E8=AF=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/06.anniv/00.readme.md | 21 +++++++------ src/06.anniv/02.user.md | 65 +++++++++++++++++++++++++-------------- 2 files changed, 53 insertions(+), 33 deletions(-) diff --git a/src/06.anniv/00.readme.md b/src/06.anniv/00.readme.md index 00b86ae..55d424c 100644 --- a/src/06.anniv/00.readme.md +++ b/src/06.anniv/00.readme.md @@ -52,13 +52,14 @@ interface ResponseBody { 通用错误如下表所示： -| 错误代码 | 详情 | -| -------- | -------------- | -| `900000` | 站点致命错误 | -| `900001` | 数据库连接错误 | -| `901000` | 数据写入错误 | -| `901001` | 数据读取错误 | -| `902000` | 内容不存在 | -| `902001` | 无权访问 | -| `902002` | 用户未登录 | -| `902003` | 非法参数 | +| 错误代码 | 详情 | +| -------- | ------------------------ | +| `900000` | 站点致命错误 | +| `900001` | 数据库连接错误 | +| `901000` | 数据写入错误 | +| `901001` | 数据读取错误 | +| `902000` | 内容不存在 | +| `902001` | 无权访问 | +| `902002` | 用户未登录 | +| `902003` | 非法参数 | +| `903000` | 超出频率限制，请稍后再试 | diff --git a/src/06.anniv/02.user.md b/src/06.anniv/02.user.md index 50ede20..6541d43 100644 --- a/src/06.anniv/02.user.md +++ b/src/06.anniv/02.user.md @@ -10,6 +10,7 @@ | `102001` | 注册邮箱不可用 | | `102010` | 邮箱或密码错误 | | `102020` | 待注销用户不存在 | +| `102030` | 验证邮件发送失败 | ## 对用户密码的预处理（建议） @@ -25,6 +26,31 @@ 用户已登录时，返回当前用户信息（`UserInfo`）。 +当用户的 `verified` 为 `false` 时，表明用户邮箱未验证。服务端可能会限制用户可用的接口，产生错误 `902001`：无权访问。 + +#### 返回参数 + +| 参数名 | 类型 | 详情 | +| ---------- | --------- | -------------------- | +| `user_id` | `string` | 用户 ID | +| `username` | `string` | 用户名 | +| `email` | `string` | 邮箱 | +| `nickname` | `string` | 昵称 | +| `avatar` | `string` | 头像链接 | +| `verified` | `boolean` | 用户邮箱是否已经确认 | + +### 参数表示 + +```typescript +interface UserInfo { + user_id: string; + username: string; + email: string; + nickname: string; + avatar: string; + verified: boolean; +} +``` ## 用户注册 ### Endpoint @@ -45,17 +71,7 @@ ### 返回 -注册成功时，返回用户信息（`UserInfo`）。 - -#### 返回参数 - -| 参数名 | 类型 | 详情 | -| ---------- | -------- | -------- | -| `user_id` | `string` | 用户 ID | -| `username` | `string` | 用户名 | -| `email` | `string` | 邮箱 | -| `nickname` | `string` | 昵称 | -| `avatar` | `string` | 头像链接 | +注册成功时，返回用户信息（`UserInfo`）。此时用户的 `verified` 为 `false`。 ### 参数表示 @@ -67,14 +83,6 @@ interface UserRegisterBody { nickname: string; avatar: string; } - -interface UserInfo { - user_id: string; - username: string; - email: string; - nickname: string; - avatar: string; -} ``` ### 错误列表 @@ -184,13 +192,24 @@ interface UserRevokeBody { | `email` | `string` | 邮箱 | | `username` | `string` | 用户名 | -### 返回 - -当检查全部通过时，返回 `204 No Content`。 - ### 错误列表 | 错误代码 | 详情 | | -------- | ---------------- | | `102000` | 注册用户名不可用 | | `102001` | 注册邮箱不可用 | + +## 验证邮箱 + +向用户的当前邮箱发送验证邮件。 + +### Endpoint + +`POST /api/user/email/verify` + +### 错误列表 + +| 错误代码 | 详情 | +| -------- | ------------------------ | +| `102030` | 验证邮件发送失败 | +| `903000` | 超出频率限制，请稍后再试 | From 0fd9fb5b7ce911fd728f1a1f697833647fff4853 Mon Sep 17 00:00:00 2001 From: Yesterday17 Date: Sun, 12 Dec 2021 23:47:12 +0800 Subject: [PATCH 2/2] =?UTF-8?q?=E5=88=A0=E9=99=A4=E9=94=99=E8=AF=AF?= =?UTF-8?q?=E4=BB=A3=E7=A0=81=20102002?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/06.anniv/02.user.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/06.anniv/02.user.md b/src/06.anniv/02.user.md index 6541d43..644890f 100644 --- a/src/06.anniv/02.user.md +++ b/src/06.anniv/02.user.md @@ -91,7 +91,6 @@ interface UserRegisterBody { | -------- | ---------------- | | `102000` | 注册用户名不可用 | | `102001` | 注册邮箱不可用 | -| `102002` | 注册密码格式错误 | ## 用户登录