Skip to content

Commit c3f2252

Browse files
committed
将获取其他用户信息的接口拆分为 /api/user/intro
1 parent 24f824b commit c3f2252

2 files changed

Lines changed: 35 additions & 10 deletions

File tree

src/06.anniv/02.user.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,33 +20,61 @@
2020

2121
`GET /api/user/info`
2222

23+
### 返回
24+
25+
用户已登录时,返回当前用户信息(`UserInfo`)。
26+
27+
#### 返回参数
28+
29+
| 参数名 | 类型 | 详情 |
30+
| ---------- | -------- | -------- |
31+
| `user_id` | `string` | 用户 ID |
32+
| `email` | `string` | 邮箱 |
33+
| `nickname` | `string` | 昵称 |
34+
| `avatar` | `string` | 头像链接 |
35+
36+
### 参数表示
37+
38+
```typescript
39+
interface UserInfo {
40+
user_id: string;
41+
email: string;
42+
nickname: string;
43+
avatar: string;
44+
}
45+
```
46+
47+
## 用户简介
48+
49+
### Endpoint
50+
51+
`GET /api/user/intro`
52+
2353
### 请求
2454

2555
#### 请求参数
2656

27-
| 参数名 | 类型 | 详情 |
28-
| --------- | -------- | ----------------------------------------------------------------------- |
29-
| `user_id` | `string` | 用户 ID <br> 该字段留空时表示请求当前登录用户的用户信息,仅登录后可用。 |
57+
| 参数名 | 类型 | 详情 |
58+
| --------- | -------- | ------- |
59+
| `user_id` | `string` | 用户 ID |
3060

3161
### 返回
3262

33-
返回指定用户的用户信息(`UserInfo`)。
63+
返回指定用户的用户简介(`UserIntro`)。
3464

3565
#### 返回参数
3666

3767
| 参数名 | 类型 | 详情 |
3868
| ---------- | -------- | -------- |
3969
| `user_id` | `string` | 用户 ID |
40-
| `email` | `string` | 邮箱 |
4170
| `nickname` | `string` | 昵称 |
4271
| `avatar` | `string` | 头像链接 |
4372

4473
### 参数表示
4574

4675
```typescript
47-
interface UserInfo {
76+
interface UserIntro {
4877
user_id: string;
49-
email: string;
5078
nickname: string;
5179
avatar: string;
5280
}
@@ -56,7 +84,6 @@ interface UserInfo {
5684

5785
| 错误代码 | 详情 |
5886
| -------- | ---------- |
59-
| `902002` | 用户未登录 |
6087
| `102020` | 用户不存在 |
6188

6289
## 用户注册

src/06.anniv/features/02.2fa.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@ interface UserRevokeBody {
6767

6868
### 用户信息
6969

70-
实现时须注意 `2fa_enabled` 字段只有在请求的用户 `ID` 与待请求用户 `ID` 相同时才能返回。
71-
7270
```typescript
7371
interface UserInfo {
7472
// ...

0 commit comments

Comments
 (0)