Skip to content

Commit 3639a4f

Browse files
committed
add: 添加暂未编写完成的api(user/message-record.md)
1 parent 271da45 commit 3639a4f

File tree

4 files changed

+77
-8
lines changed

4 files changed

+77
-8
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Codemao API 项目由编程猫社区用户发起,旨在为广大训练师提
2727
- 如果请求不需要用到 cookie,不会专门标注
2828

2929
2. API 中的`返回内容`栏目表现的是请求成功的理想状态
30+
3. `10|[5,200]`中 10 表示默认值为 10,`|`后面为取值范围(区间表示,取整数),此处最小为 5,最大为 200
3031

3132
## 加入我们
3233

_sidebar.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
- [修改用户信息](/user/update-info)
44
- [设置用户名](/user/set-username)
55
- [修改用户密码](/user/update-password)
6-
- [消息](/user/messages)
6+
- [新消息数量](/user/message-count)
7+
- [消息记录](/user/message-record)
78
- [个人信息(details)](/user/details)
89
- [个人信息(info)](/user/info)
910
- [其他用户信息](/user/user-details)

user/messages.md user/message-count.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 消息
1+
# 新消息数量
22

3-
> 获取新消息数量
3+
> 获取自己的新消息数量
44
> `/web/message-record/count` `GET` `需要cookies`
55
66
## 返回内容
@@ -14,11 +14,11 @@
1414

1515
### `query_type`说明: :id=description_query_type
1616

17-
| 类型 | |
18-
| :--------: | :-----------: |
19-
| 评论与回复 | COMMENT_REPLY |
20-
| 赞与被购买 | LIKE_FORK |
21-
| 系统消息 | SYSTEM |
17+
| value | description |
18+
| :-----------: | :---------: |
19+
| COMMENT_REPLY | 评论与回复 |
20+
| LIKE_FORK | 赞与被购买 |
21+
| SYSTEM | 系统消息 |
2222

2323
### 示例
2424

user/message-record.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# 消息记录
2+
3+
!> 这个 API 文档正在编写中,请勿使用
4+
5+
> 获取自己的消息记录
6+
> `/web/message-record` `GET` `需要cookies`
7+
8+
## URL 参数
9+
10+
| key | value | type | |
11+
| :-----------------------------------: | :-----------------------: | :----: | :----: |
12+
| [query_type](#description_query_type) | 消息类型 | string | `必须` |
13+
| limit | 每一页的数量`10\|[5,200]` | int | `可选` |
14+
| offset | 页码 | int | `可选` |
15+
16+
### `query_type`说明: :id=description_query_type
17+
18+
| value | description |
19+
| :-----------: | :---------: |
20+
| COMMENT_REPLY | 评论与回复 |
21+
| LIKE_FORK | 赞与被购买 |
22+
| SYSTEM | 系统消息 |
23+
24+
## 返回内容
25+
26+
| key | value | type |
27+
| :-----: | :----------------------------------------------: | :--: |
28+
| items | 由多个 JSON 构成的消息列表([查看详情](#items)| list |
29+
| offset | 页码 | int |
30+
| limit | 每一页的数量 | int |
31+
| total | `未知` | int |
32+
| counted | `未知` | bool |
33+
34+
### items
35+
36+
| key | value | type |
37+
| :----------: | :--------------------------------------: | :----: |
38+
| id | 消息 ID | string |
39+
| type | 消息类型([查看详情](#type)| string |
40+
| content | 消息具体内容([查看详情](#content)| string |
41+
| reference_id | `未知` | string |
42+
| sender_id | 消息发送者 ID | string |
43+
| receiver_id | 消息接收者 ID | string |
44+
| read_status | 阅读状态(`READ`为已读,`UNREAD`为未读) | string |
45+
| created_at | 消息产生时间戳 | int |
46+
47+
#### type
48+
49+
| value | description |
50+
| :-----------------------: | :----------------: |
51+
| WORK_COMMENT | 作品被评论 |
52+
| WORK_REPLY | 作品下的评论被回复 |
53+
| WORK_REPLY_AUTHOR | |
54+
| WORK_REPLY_REPLY_FEEDBACK | |
55+
| POST_COMMENT | |
56+
| POST_REPLY | |
57+
| POST_REPLY_REPLY | |
58+
| POST_REPLY_REPLY_FEEDBACK | |
59+
| WORK_FORK | 作品被购买 |
60+
| WORK_LIKE | 作品被点赞 |
61+
| WORK_DISCUSSION_LIKED | |
62+
| POST_DISCUSSION_LIKED | |
63+
| BROADCAST | |
64+
65+
#### content
66+
67+
> 更新于 2023.01.18

0 commit comments

Comments
 (0)