Skip to content

Commit 90cea2a

Browse files
1ctrl-cvQianLin-Jiaxi
authored andcommitted
docs(api/v1/user.md): 统一注释
1 parent 133c92b commit 90cea2a

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

src/api/v1/user.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ GET /v1/user/info
5959
```ProtoBuf
6060
status {
6161
number: 114514
62-
code: 1
63-
msg: "success"
62+
code: 1 // 请求状态码,1为正常
63+
msg: "success" // 返回消息
6464
}
6565
data {
6666
id: "123" // 用户id
@@ -124,8 +124,8 @@ message get_user_send {
124124
```ProtoBuf
125125
status {
126126
number: 123456
127-
code: 1
128-
msg: "success"
127+
code: 1 // 请求状态码,1为正常
128+
msg: "success" // 返回消息
129129
}
130130
data {
131131
id: "123" // 用户ID
@@ -188,8 +188,8 @@ POST /v1/user/medal
188188
```ProtoBuf
189189
status {
190190
number: 114514
191-
code: 1
192-
msg: "success"
191+
code: 1 // 请求状态码,1为正常
192+
msg: "success" // 返回消息
193193
}
194194
medal {
195195
id: 1 // 勋章ID
@@ -241,8 +241,8 @@ message edit_nickname_send {
241241
```ProtoBuf
242242
status {
243243
number: 114514
244-
code: 1
245-
msg: "success"
244+
code: 1 // 请求状态码,1为正常
245+
msg: "success" // 返回消息
246246
}
247247
```
248248

@@ -281,8 +281,8 @@ message edit_avatar_send {
281281
```ProtoBuf
282282
status {
283283
number: 114514
284-
code: 1
285-
msg: "success"
284+
code: 1 // 请求状态码,1为正常
285+
msg: "success" // 返回消息
286286
}
287287
```
288288

@@ -313,11 +313,11 @@ POST /v1/user/email-login
313313
响应体:
314314
```JSONC
315315
{
316-
"code": 1, // 状态码,正常为1
316+
"code": 1, // 请求状态码,1为正常
317317
"data": {
318318
"token": "abcdefg1-xxxx-xxxx-xxxxxxxxxx" // 登录效验令牌
319319
},
320-
"msg": "success" // 状态信息
320+
"msg": "success" // 返回消息
321321
}
322322
```
323323

@@ -333,8 +333,8 @@ POST /v1/user/logout
333333
响应体:
334334
```JSONC
335335
{
336-
"code": 1, // 状态码,正常为1
337-
"msg": "success" // 状态信息
336+
"code": 1, // 请求状态码,1为正常
337+
"msg": "success" // 返回消息
338338
}
339339
```
340340

0 commit comments

Comments
 (0)