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 a9fa938..f7ef446 100644 --- a/src/06.anniv/02.user.md +++ b/src/06.anniv/02.user.md @@ -4,11 +4,12 @@ ## 错误代码一览 -| 错误代码 | 详情 | -| -------- | -------------- | -| `102001` | 注册邮箱不可用 | -| `102010` | 邮箱或密码错误 | -| `102020` | 用户不存在 | +| 错误代码 | 详情 | +| -------- | ---------------- | +| `102001` | 注册邮箱不可用 | +| `102010` | 邮箱或密码错误 | +| `102020` | 用户不存在 | +| `102030` | 验证邮件发送失败 | ## 对用户密码的预处理 @@ -24,14 +25,17 @@ 用户已登录时,返回当前用户信息(`UserInfo`)。 +当用户的 `verified` 为 `false` 时,表明用户邮箱未验证。服务端可能会限制用户可用的接口,产生错误 `902001`:无权访问。 + #### 返回参数 -| 参数名 | 类型 | 详情 | -| ---------- | -------- | -------- | -| `user_id` | `string` | 用户 ID | -| `email` | `string` | 邮箱 | -| `nickname` | `string` | 昵称 | -| `avatar` | `string` | 头像链接 | +| 参数名 | 类型 | 详情 | +| ---------- | --------- | -------------------- | +| `user_id` | `string` | 用户 ID | +| `email` | `string` | 邮箱 | +| `nickname` | `string` | 昵称 | +| `avatar` | `string` | 头像链接 | +| `verified` | `boolean` | 用户邮箱是否已经确认 | ### 参数表示 @@ -41,6 +45,7 @@ interface UserInfo { email: string; nickname: string; avatar: string; + verified: boolean; } ``` @@ -105,7 +110,7 @@ interface UserIntro { ### 返回 -注册成功时,返回用户信息(`UserInfo`)。 +注册成功时,返回用户信息(`UserInfo`)。此时用户的 `verified` 为 `false`。 ### 参数表示 @@ -122,9 +127,7 @@ interface UserRegisterBody { | 错误代码 | 详情 | | -------- | ---------------- | -| `102000` | 注册用户名不可用 | | `102001` | 注册邮箱不可用 | -| `102002` | 注册密码格式错误 | ## 用户登录 @@ -212,12 +215,27 @@ interface UserRevokeBody { #### 请求参数 -| 参数 | 类型 | 详情 | -| ------- | -------- | ---- | -| `email` | `string` | 邮箱 | +| 参数 | 类型 | 详情 | +| ---------- | -------- | ------ | +| `email` | `string` | 邮箱 | ### 错误列表 -| 错误代码 | 详情 | -| -------- | -------------- | -| `102001` | 注册邮箱不可用 | +| 错误代码 | 详情 | +| -------- | ---------------- | +| `102001` | 注册邮箱不可用 | + +## 验证邮箱 + +向用户的当前邮箱发送验证邮件。 + +### Endpoint + +`POST /api/user/email/verify` + +### 错误列表 + +| 错误代码 | 详情 | +| -------- | ------------------------ | +| `102030` | 验证邮件发送失败 | +| `903000` | 超出频率限制,请稍后再试 | \ No newline at end of file