新增：更改邮箱相关接口文档

2026-05-02 19:30:48 +08:00 · 2022-09-29 13:58:14 +08:00
parent 2cde13eabb
commit 55170c7693
3 changed files with 427 additions and 4 deletions
--- a/app/docs/slate/source/includes/_users.md
+++ b/app/docs/slate/source/includes/_users.md
@@ -2304,4 +2304,189 @@ await octokit.request('GET /api/users/:login/applied_projects/:id/refuse.json')
    "created_at": "2021-06-09 16:41",
    "time_ago": "7分钟前"
 }
+```
+
+
+## 用户发送邮件验证码
+用户发送邮件验证码
+
+> 示例:
+
+```shell
+curl -X GET http://localhost:3000/api/v1/yystopf/send_email_vefify_code.json
+```
+
+```javascript
+await octokit.request('GET /api/v1/:login/send_email_vefify_code.json')
+```
+
+### HTTP 请求
+`GET /api/v1/:login/send_email_vefify_code.json`
+
+### 请求字段说明:
+参数  | 类型 | 字段说明
+--------- | ----------- | -----------
+|login       |string   |用户标识 |
+|code_type   |int      |10: 更新邮箱|
+|email       |string   |邮箱|
+|smscode     |string   |邮箱md5加密值|
+
+### 返回字段说明:
+
+> 返回的JSON示例:
+
+```json
+{
+    "status": 0,
+    "message": "success"
+}
+```
+
+
+## 用户验证邮件验证码
+用户验证邮件验证码
+
+> 示例:
+
+```shell
+curl -X POST http://localhost:3000/api/v1/yystopf/check_email_verify_code.json
+```
+
+```javascript
+await octokit.request('POST /api/v1/:login/check_email_verify_code.json')
+```
+
+### HTTP 请求
+`POST /api/v1/:login/check_email_verify_code.json`
+
+### 请求字段说明:
+参数  | 类型 | 字段说明
+--------- | ----------- | -----------
+|login       |string   |用户标识 |
+|code_type   |int      |10: 更新邮箱|
+|email       |string   |邮箱|
+|code        |string   |邮箱验证码|
+
+### 返回字段说明:
+
+> 返回的JSON示例:
+
+```json
+{
+    "status": 0,
+    "message": "success"
+}
+```
+
+
+## 用户验证密码
+用户验证密码，检查是否和用户密码一致
+
+> 示例:
+
+```shell
+curl -X POST http://localhost:3000/api/v1/yystopf/check_password.json
+```
+
+```javascript
+await octokit.request('POST /api/v1/:login/check_password.json')
+```
+
+### HTTP 请求
+`POST /api/v1/:login/check_password.json`
+
+### 请求字段说明:
+参数  | 类型 | 字段说明
+--------- | ----------- | -----------
+|login       |string   |用户标识 |
+|password    |string   |用户密码|
+
+### 返回字段说明:
+
+> 返回的JSON示例:
+
+```json
+{
+    "status": 0,
+    "message": "success"
+}
+```
+
+
+## 用户验证邮箱
+用户验证邮箱是否符合规范以及是否已被使用
+
+> 示例:
+
+```shell
+curl -X POST http://localhost:3000/api/v1/yystopf/check_email.json
+```
+
+```javascript
+await octokit.request('POST /api/v1/:login/check_email.json')
+```
+
+### HTTP 请求
+`POST /api/v1/:login/check_email.json`
+
+### 请求字段说明:
+参数  | 类型 | 字段说明
+--------- | ----------- | -----------
+|login       |string   |用户标识 |
+|email    |string   |邮箱地址|
+
+### 返回字段说明:
+
+> 返回的JSON示例:
+
+```json
+{
+    "status": 0,
+    "message": "success"
+}
+```
+
+
+## 用户更改邮箱
+用户更改一个新的邮箱
+
+> 示例:
+
+```shell
+curl -X PATCH http://localhost:3000/api/v1/yystopf/update_email.json
+```
+
+```javascript
+await octokit.request('PATCH /api/v1/:login/update_email.json')
+```
+
+### HTTP 请求
+`PATCH /api/v1/:login/update_email.json`
+
+### 请求字段说明:
+参数  | 类型 | 字段说明
+--------- | ----------- | -----------
+|login       |string   |用户标识 |
+|password    |string   |用户密码|
+|email       |string   |邮箱地址|
+|code        |string   |邮箱验证码|
+
+
+> 请求的JSON示例:
+
+```json
+{
+    "password": "Aa19960425.",
+    "code": "657134",
+    "email": "yystopf@163.com"
+}
+```
+
+> 返回的JSON示例:
+
+```json
+{
+    "status": 0,
+    "message": "success"
+}
 ```