XFE Git
XFE Studio Git
Git 首页 全局搜索
XFE 主站 文档 NuGet
公开
关注 0 Fork 0 Star 0
返回提交历史

XFEstudio/bilibili-API-collect

feat: 规范化文档

478feea
wuziqian211 <65224318+wuziqian211@users.noreply.github.com>
提交于

代码差异

3 个文件 +174 -134
Modified docs/dynamic/action.md +31 -73
@@ -10,95 +10,53 @@
10 10
11 11 **正文参数(multipart/form-data):**
12 12
13 | 参数名 | 类型 | 内容 |
14 | ---------- | ---- | ------ |
15 | dynamic_id | num | 动态id |
16 | csrf_token | str | csrf |
13 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
14 | ---------- | ---- | ------ | ------ | ---- |
15 | dynamic_id | num | 动态id | 必要 | |
16 | csrf_token | str | csrf | 必要 | |
17 | csrf | str | csrf | 必要 | |
17 18
18 19 **json回复:**
19 20
20 21 根对象:
21 22
22 | 字段 | 类型 | 内容 |
23 | ------- | ---- | ----------------- |
24 | code | num | 0:成功 |
25 | | | 500404:已经删除过 |
26 | | | 500406:不是自己的 |
27 | msg | str | 错误信息 |
28 | message | str | 和msg一样 |
29 | data | obj | 未知 |
23 | 字段 | 类型 | 内容 | 备注 |
24 | ------- | ---- | -------- | --------------------------------------------------------------------------------------- |
25 | code | num | 返回值 | 0:成功<br />-101:账号未登录<br />500404:已经删除过该动态<br />500406:动态不是自己的 |
26 | msg | str | 错误信息 | 成功时为空文本 |
27 | message | str | 错误信息 | 同`msg` |
28 | data | obj | 数据本体 | |
30 29
31 <details>
32 <summary>查看示例</summary>
33
34
35 ```bash
36 curl 'https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/rm_dynamic' \
37 -X POST \
38 -H 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:93.0) Gecko/20100101 Firefox/93.0' \
39 -H 'Referer: https://t.bilibili.com/' \
40 -H 'Cookie: SESSDATA=********; bili_jct=de2731532b4ab96bc8536da948932668;' \
41 --data-raw 'dynamic_id=588320531406678918&csrf_token=de2731532b4ab96bc8536da948932668&csrf=de2731532b4ab96bc8536da948932668'
42 ```
43
44 ```json
45 {
46 "code":0,
47 "msg":"",
48 "message":"",
49 "data": {
50 "_gt_":0
51 }
52 }
53 ```
30 `data`对象:
54 31
55 </details>
56
57 ## 删除草稿
32 | 字段 | 类型 | 内容 | 备注 |
33 | ------- | ---- | ---- | ---------------- |
34 | \_gt\_ | num | 0 | **作用尚不明确** |
58 35
59 > https://api.vc.bilibili.com/dynamic_draft/v1/dynamic_draft/rm_draft
36 **示例:**
60 37
61 *请求方式:POST*
38 删除动态`dynamic_id=588320531406678918`
62 39
63 认证方式:Cookie(SESSDATA)
64
65 **正文参数(application/x-www-form-urlencoded):**
66
67 | 参数名 | 类型 | 内容 |
68 | ---------- | ---- | -------------- |
69 | draft_id | num | 定时发送草稿id |
70 | csrf_token | str | csrf |
71
72 **json回复:**
73
74 根对象:
75
76 | 字段 | 类型 | 内容 |
77 | ------- | ---- | ---------------------------- |
78 | code | num | 0:成功<br/>4120015: 系统异常 |
79 | message | str | 错误信息 |
80 | ttl | num | 1 |
81 | data | obj | 空对象 |
40 ```shell
41 curl 'https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/rm_dynamic' \
42 --data-urlencode 'dynamic_id=588320531406678918' \
43 --data-urlencode 'csrf_token=xxx' \
44 --data-urlencode 'csrf=xxx' \
45 -b 'SESSDATA=xxx'
46 ```
82 47
83 48 <details>
84 <summary>查看示例</summary>
85
86
87 ```bash
88 curl -X POST 'https://api.vc.bilibili.com/dynamic_draft/v1/dynamic_draft/rm_draft' \
89 -b 'SESSDATA=xxxx;' \
90 ```
49 <summary>查看响应示例:</summary>
91 50
92 51 ```json
93 52 {
94 "code": 0,
95 "message": "0",
96 "ttl": 1,
97 "data": {}
53 "code": 0,
54 "msg": "",
55 "message": "",
56 "data": {
57 "_gt_": 0
58 }
98 59 }
99 60 ```
100 61
101 62 </details>
102
Modified docs/dynamic/atlist.md +141 -59
@@ -1,6 +1,6 @@
1 # 根据关键字搜索用户(at别人时的填充列表)
1 # 根据关键字搜索用户 (at别人时的填充列表)
2 2
3 **注意关键字不一定顺序匹配,如最后示例**
3 **注意关键字不一定顺序匹配,如最后示例**
4 4
5 5 > https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search
6 6
@@ -8,60 +8,79 @@
8 8
9 9 认证方式:Cookie(SESSDATA)
10 10
11 **正文参数(multipart/form-data):**
11 **url参数:**
12 12
13 | 参数名 | 类型 | 内容 |
14 | --- | --- | --- |
15 | uid | num | 自己的uid |
16 | keyword | str | 搜索关键字 |
13 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
14 | ------- | ---- | ---------- | ------ | ---- |
15 | uid | num | 自己的mid | 必要 | |
16 | keyword | str | 搜索关键字 | 必要 | |
17 17
18 18 **json回复:**
19 19
20 20 根对象:
21 21
22 | 字段 | 类型 | 内容 |
23 | --- | --- | --- |
24 | code | num | 0成功 |
25 | msg | str | 成功为空文本 |
26 | message | str | 同msg |
27 | data | obj | 数据本体 |
22 | 字段 | 类型 | 内容 | 备注 |
23 | ------- | ---- | -------- | --------------------------------------------------------------------------------------------- |
24 | code | num | 返回值 | 0:成功<br />1024:系统开小差了<br />2001:关键字不合法<br />7600001:参数出错了,请输入正确参数<br />7600008:`uid`参数与自己的mid不匹配 |
25 | msg | str | 错误信息 | 成功时为空文本 |
26 | message | str | 错误信息 | 同`msg` |
27 | data | obj | 数据本体 | |
28 28
29 data对象:
29 `data`对象:
30 30
31 | 字段 | 类型 | 内容 |
32 | --- | --- | --- |
33 | groups | obj[] | 内容分组(好像是根据关注列表分) |
34 | \_gt_ | num | 0 |
31 | 字段 | 类型 | 内容 | 备注 |
32 | ------ | ----- | -------- | -------------------------------------------- |
33 | groups | array | 用户分组 | 根据是否关注该用户来分组,未找到用户时无此项 |
34 | \_gt\_ | num | 0 | **作用尚不明确** |
35 35
36 group对象:
36 `groups`数组:
37 37
38 | 字段 | 类型 | 内容 |
39 | --- | --- | --- |
40 | group_type | num | 2:我的关注<br>4:其他 |
41 | group_name | str | 分组名字 |
42 | items | obj[] | 用户信息 |
38 | 项 | 类型 | 内容 | 备注 |
39 | ---- | ---- | --------- | ---- |
40 | 0 | obj | 分组1 | |
41 | n | obj | 分组(n+1) | |
42 | …… | obj | …… | …… |
43 43
44 item对象:
44 `groups`数组中的对象:
45 45
46 | 字段 | 类型 | 内容 |
47 | --- | --- | --- |
48 | uid | num | 用户id |
49 | uname | str | 用户昵称 |
50 | face | str | 用户头像url |
51 | fans | num | 用户粉丝数 |
52 | official_verify_type | num | 认证信息? |
46 | 字段 | 类型 | 内容 | 备注 |
47 | ---------- | ----- | ---------------- | ------------------------ |
48 | group_type | num | 分组类型 | 2:我的关注<br />4:其他 |
49 | group_name | str | 分组名称 | `我的关注`或`其他` |
50 | items | array | 搜索到的用户信息 | 按照认证状态与粉丝数排序 |
53 51
54 <details>
55 <summary>查看示例</summary>
52 `items`数组:
53
54 | 项 | 类型 | 内容 | 备注 |
55 | ---- | ---- | --------- | ---- |
56 | 0 | obj | 用户1 | |
57 | n | obj | 用户(n+1) | |
58 | …… | obj | …… | …… |
59
60 `items`数组中的对象:
61
62 | 字段 | 类型 | 内容 | 备注 |
63 | -------------------- | ---- | ------------ | ---------------------------------------- |
64 | uid | num | 用户mid | |
65 | uname | str | 用户昵称 | |
66 | face | str | 用户头像url | |
67 | fans | num | 用户粉丝数 | |
68 | official_verify_type | num | 用户认证状态 | -1:无<br />0:个人认证<br />1:机构认证 |
69
70 **示例:**
71
72 搜索关键字为`社会易`的用户
56 73
57 74 ```shell
58 # 搜索关键字:社会易
59 curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858903&keyword=%e7%a4%be%e4%bc%9a%e6%98%93' \
60 -H 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:93.0) Gecko/20100101 Firefox/93.0' -H 'Accept: application/json, text/plain, */*' \
61 -H 'Referer: https://t.bilibili.com/' \
62 -H 'Cookie: SESSDATA=******'
75 curl -G 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search' \
76 --data-urlencode 'uid=15858903' \
77 --data-urlencode 'keyword=社会易' \
78 -b 'SESSDATA=xxx'
63 79 ```
64 80
81 <details>
82 <summary>查看响应示例:</summary>
83
65 84 ```json
66 85 {
67 86 "code": 0,
@@ -77,7 +96,7 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
77 96 "uid": 293793435,
78 97 "uname": "社会易姐QwQ",
79 98 "face": "https://i0.hdslb.com/bfs/face/aebb2639a0d47f2ce1fec0631f412eaf53d4a0be.jpg",
80 "fans": 1179,
99 "fans": 3578,
81 100 "official_verify_type": -1
82 101 }
83 102 ]
@@ -87,24 +106,38 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
87 106 "group_name": "其他",
88 107 "items": [
89 108 {
90 "uid": 250129011,
91 "uname": "社会小伙肖子易",
92 "face": "https://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg",
109 "uid": 484031754,
110 "uname": "社会易老师",
111 "face": "https://i0.hdslb.com/bfs/face/dbc456bdec5e7a4806c9d0311d95ebcc6be674cf.jpg",
112 "fans": 21169,
113 "official_verify_type": -1
114 },
115 {
116 "uid": 442101413,
117 "uname": "社会李易儒",
118 "face": "https://i2.hdslb.com/bfs/face/311cecf9298158b8a5f47ed3e641328ab5c0cfcd.jpg",
119 "fans": 10,
120 "official_verify_type": -1
121 },
122 {
123 "uid": 3546589855484501,
124 "uname": "日本国立貿易株式会社",
125 "face": "https://i2.hdslb.com/bfs/face/2dad05e4748b5e91e1ec5d3c5d4f0904a5bcdaf0.jpg",
93 126 "fans": 7,
94 127 "official_verify_type": -1
95 128 },
96 129 {
97 "uid": 394873001,
98 "uname": "社会你易叔",
99 "face": "https://i2.hdslb.com/bfs/face/bde2811aa895e349036aba9ece5630bcd1341ff0.jpg",
100 "fans": 5,
130 "uid": 250129011,
131 "uname": "社会小伙肖子易",
132 "face": "https://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg",
133 "fans": 6,
101 134 "official_verify_type": -1
102 135 },
103 136 {
104 137 "uid": 486568790,
105 138 "uname": "社会主义接班人小易",
106 139 "face": "https://i2.hdslb.com/bfs/face/1ebb0d4aa8e2c4b532f82983503ec38b62a1820f.jpg",
107 "fans": 3,
140 "fans": 4,
108 141 "official_verify_type": -1
109 142 },
110 143 {
@@ -114,13 +147,6 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
114 147 "fans": 2,
115 148 "official_verify_type": -1
116 149 },
117 {
118 "uid": 496622388,
119 "uname": "社会你易哥",
120 "face": "https://i0.hdslb.com/bfs/face/daac5514a7622741f767c68b1cbc6b91e60b4798.jpg",
121 "fans": 1,
122 "official_verify_type": -1
123 },
124 150 {
125 151 "uid": 457675287,
126 152 "uname": "易社会",
@@ -129,10 +155,66 @@ curl 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search?uid=15858
129 155 "official_verify_type": -1
130 156 },
131 157 {
132 "uid": 123270058,
133 "uname": "周易社会",
134 "face": "https://i1.hdslb.com/bfs/face/c6100396729112230deb3b0972db1504e9ce21bf.jpg",
135 "fans": 1,
158 "uid": 1602175830,
159 "uname": "不谦易会社恐",
160 "face": "https://i0.hdslb.com/bfs/face/de6afbda484e114b7cedeb621c3cbbaef7800988.jpg",
161 "fans": 0,
162 "official_verify_type": -1
163 },
164 {
165 "uid": 155817540,
166 "uname": "社会易总",
167 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
168 "fans": 8,
169 "official_verify_type": -1
170 },
171 {
172 "uid": 3546578331634371,
173 "uname": "社会存在与社会易逝",
174 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
175 "fans": 0,
176 "official_verify_type": -1
177 },
178 {
179 "uid": 1983403996,
180 "uname": "社会易姐QAQ",
181 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
182 "fans": 0,
183 "official_verify_type": -1
184 },
185 {
186 "uid": 408471763,
187 "uname": "社会易大佬人狠话不多",
188 "face": "https://i1.hdslb.com/bfs/face/510cde8f4e3eb27aa50177d619a4200bb501797b.jpg",
189 "fans": 0,
190 "official_verify_type": -1
191 },
192 {
193 "uid": 384672256,
194 "uname": "社会易轩",
195 "face": "https://i1.hdslb.com/bfs/face/7324adb53362527a1bf5f20141a6ae4307011ea7.jpg",
196 "fans": 0,
197 "official_verify_type": -1
198 },
199 {
200 "uid": 284984452,
201 "uname": "社会易哥",
202 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
203 "fans": 0,
204 "official_verify_type": -1
205 },
206 {
207 "uid": 249112673,
208 "uname": "社会易姐",
209 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
210 "fans": 0,
211 "official_verify_type": -1
212 },
213 {
214 "uid": 167967213,
215 "uname": "社会易大佬",
216 "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg",
217 "fans": 0,
136 218 "official_verify_type": -1
137 219 }
138 220 ]
Modified docs/user/info.md +2 -2
@@ -943,7 +943,7 @@ curl -G 'https://api.bilibili.com/x/space/myinfo' \
943 943
944 944 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
945 945 | ------ | ---- | ----------------- | ------ | ------------------- |
946 | uids | nums | 目标用户的UID列表 | 必要 | 每个成员间用`,`分隔 |
946 | uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔 |
947 947
948 948 **json回复:**
949 949
@@ -1206,7 +1206,7 @@ curl -G 'https://api.bilibili.com/x/polymer/pc-electron/v1/user/cards' \
1206 1206
1207 1207 | 参数名 | 类型 | 内容 | 必要性 | 备注 |
1208 1208 | ------ | ---- | ----------------- | ------ | --------------------------------------------------------------------- |
1209 | uids | nums | 目标用户的UID列表 | 必要 | 每个成员间用`,`分隔,最多50个成员,若超过此限制则返回的`data`数组为空 |
1209 | uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔,最多50个成员,若超过此限制则返回的`data`数组为空 |
1210 1210
1211 1211 **json回复:**
1212 1212