From 1817c58d0cf4586764fa517d36ba8a197634a286 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=99=A8=E5=8F=B6=E6=A2=A6=E6=98=A5?= <65224318+wuziqian211@users.noreply.github.com> Date: Thu, 19 Sep 2024 00:18:08 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0=E5=8A=A8=E6=80=81=20?= =?UTF-8?q?at=20=E5=A1=AB=E5=85=85=E5=88=97=E8=A1=A8=E3=80=81=E5=A4=9A?= =?UTF-8?q?=E7=94=A8=E6=88=B7=E4=BF=A1=E6=81=AF=E7=9A=84=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E8=AF=B4=E6=98=8E=20(#1101)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add get users info * 将 #983 中对此文件的更改合并到此 PR 中 * fix: typo * Update info.md * 更新 danmaku_view_proto.md * 更新 action.md * 更新 info.md * 更新 recommend.md * 更新 readme.md * feat: 规范化文档 * Update info.md * Update atlist.md * Update atlist.md --- docs/dynamic/atlist.md | 190 ++++++++++++++++++++++------------------- docs/user/info.md | 20 ++--- 2 files changed, 109 insertions(+), 101 deletions(-) diff --git a/docs/dynamic/atlist.md b/docs/dynamic/atlist.md index 9607a54e17..a73734f0bb 100644 --- a/docs/dynamic/atlist.md +++ b/docs/dynamic/atlist.md @@ -2,7 +2,7 @@ **注意关键字不一定顺序匹配,如最后示例** -> https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search +> https://api.bilibili.com/x/polymer/web-dynamic/v1/mention/search *请求方式:GET* @@ -10,28 +10,26 @@ **url参数:** -| 参数名 | 类型 | 内容 | 必要性 | 备注 | -| ------- | ---- | ---------- | ------ | ---- | -| uid | num | 自己的mid | 必要 | | -| keyword | str | 搜索关键字 | 必要 | | +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ------- | ---- | ---------- | ------ | ---------------------------------- | +| keyword | str | 搜索关键字 | 非必要 | 若无此项,则返回所有关注用户的信息 | **json回复:** 根对象: -| 字段 | 类型 | 内容 | 备注 | -| ------- | ---- | -------- | --------------------------------------------------------------------------------------------- | -| code | num | 返回值 | 0:成功
1024:系统开小差了
2001:关键字不合法
7600001:参数出错了,请输入正确参数
7600008:`uid`参数与自己的mid不匹配 | -| msg | str | 错误信息 | 成功时为空文本 | -| message | str | 错误信息 | 同`msg` | -| data | obj | 数据本体 | | +| 字段 | 类型 | 内容 | 备注 | +| ------- | ---- | -------- | ----------------------------- | +| code | num | 返回值 | 0:成功
-101:账号未登录 | +| message | str | 错误信息 | 成功时为 `0` | +| ttl | num | 1 | | +| data | obj | 数据本体 | | `data`对象: -| 字段 | 类型 | 内容 | 备注 | -| ------ | ----- | -------- | -------------------------------------------- | -| groups | array | 用户分组 | 根据是否关注该用户来分组,未找到用户时无此项 | -| \_gt\_ | num | 0 | **作用尚不明确** | +| 字段 | 类型 | 内容 | 备注 | +| ------ | ----- | -------- | ---------------------------------------------- | +| groups | array | 用户分组 | 根据是否关注该用户来分组,未找到用户时为空数组 | `groups`数组: @@ -45,8 +43,8 @@ | 字段 | 类型 | 内容 | 备注 | | ---------- | ----- | ---------------- | ------------------------ | -| group_type | num | 分组类型 | 2:我的关注
4:其他 | | group_name | str | 分组名称 | `我的关注`或`其他` | +| group_type | num | 分组类型 | 2:我的关注
4:其他 | | items | array | 搜索到的用户信息 | 按照认证状态与粉丝数排序 | `items`数组: @@ -61,19 +59,18 @@ | 字段 | 类型 | 内容 | 备注 | | -------------------- | ---- | ------------ | ---------------------------------------- | -| uid | num | 用户mid | | -| uname | str | 用户昵称 | | | face | str | 用户头像url | | | fans | num | 用户粉丝数 | | +| name | str | 用户昵称 | | | official_verify_type | num | 用户认证状态 | -1:无
0:个人认证
1:机构认证 | +| uid | str | 用户mid | | **示例:** 搜索关键字为`社会易`的用户 ```shell -curl -G 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search' \ ---data-urlencode 'uid=15858903' \ +curl -G 'https://api.bilibili.com/x/polymer/web-dynamic/v1/mention/search' \ --data-urlencode 'keyword=社会易' \ -b 'SESSDATA=xxx' ``` @@ -84,143 +81,156 @@ curl -G 'https://api.vc.bilibili.com/dynamic_mix/v1/dynamic_mix/at_search' \ ```json { "code": 0, - "msg": "", - "message": "", + "message": "0", + "ttl": 1, "data": { "groups": [ { - "group_type": 2, "group_name": "我的关注", + "group_type": 2, "items": [ { - "uid": 293793435, - "uname": "社会易姐QwQ", "face": "https://i0.hdslb.com/bfs/face/aebb2639a0d47f2ce1fec0631f412eaf53d4a0be.jpg", - "fans": 3578, - "official_verify_type": -1 + "fans": 3613, + "name": "社会易姐QwQ", + "official_verify_type": -1, + "uid": "293793435" } ] }, { - "group_type": 4, "group_name": "其他", + "group_type": 4, "items": [ { - "uid": 484031754, - "uname": "社会易老师", "face": "https://i0.hdslb.com/bfs/face/dbc456bdec5e7a4806c9d0311d95ebcc6be674cf.jpg", - "fans": 21169, - "official_verify_type": -1 + "fans": 23464, + "name": "社会易老师", + "official_verify_type": -1, + "uid": "484031754" + }, + { + "face": "https://i1.hdslb.com/bfs/face/5497859a550a017d0a51c640d232c539c2f48991.jpg", + "fans": 11, + "name": "栄禧貿易株式会社", + "official_verify_type": -1, + "uid": "4991467" }, { - "uid": 442101413, - "uname": "社会李易儒", "face": "https://i2.hdslb.com/bfs/face/311cecf9298158b8a5f47ed3e641328ab5c0cfcd.jpg", "fans": 10, - "official_verify_type": -1 + "name": "社会李易儒", + "official_verify_type": -1, + "uid": "442101413" }, { - "uid": 3546589855484501, - "uname": "日本国立貿易株式会社", "face": "https://i2.hdslb.com/bfs/face/2dad05e4748b5e91e1ec5d3c5d4f0904a5bcdaf0.jpg", - "fans": 7, - "official_verify_type": -1 + "fans": 8, + "name": "日本国立貿易株式会社", + "official_verify_type": -1, + "uid": "3546589855484501" }, { - "uid": 250129011, - "uname": "社会小伙肖子易", - "face": "https://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg", + "face": "http://i0.hdslb.com/bfs/face/2ae12d7f71173baa8e00c4cfe97acb5a3de31566.jpg", "fans": 6, - "official_verify_type": -1 + "name": "社会小伙肖子易", + "official_verify_type": -1, + "uid": "250129011" }, { - "uid": 486568790, - "uname": "社会主义接班人小易", "face": "https://i2.hdslb.com/bfs/face/1ebb0d4aa8e2c4b532f82983503ec38b62a1820f.jpg", "fans": 4, - "official_verify_type": -1 + "name": "社会主义接班人小易", + "official_verify_type": -1, + "uid": "486568790" }, { - "uid": 497214639, - "uname": "社会你易易", - "face": "https://i0.hdslb.com/bfs/face/dccb52f3c15ba1bb99aac3c86e9825842cc95295.jpg", + "face": "http://i0.hdslb.com/bfs/face/dccb52f3c15ba1bb99aac3c86e9825842cc95295.jpg", "fans": 2, - "official_verify_type": -1 + "name": "社会你易易", + "official_verify_type": -1, + "uid": "497214639" }, { - "uid": 457675287, - "uname": "易社会", - "face": "https://i0.hdslb.com/bfs/face/632bf9dd17f4e9f2f12be2c0ad00cdacd2d825fa.jpg", + "face": "https://i1.hdslb.com/bfs/face/1902cc0b07ab4a5de6110f5adb2691cbf7051f2b.jpg", "fans": 1, - "official_verify_type": -1 + "name": "社会打工不容易", + "official_verify_type": -1, + "uid": "3546742186314202" + }, + { + "face": "https://i0.hdslb.com/bfs/face/19ee1b5975969a47ba085cd1f628d86a479b9950.jpg", + "fans": 0, + "name": "社会交易", + "official_verify_type": -1, + "uid": "3493291412687622" }, { - "uid": 1602175830, - "uname": "不谦易会社恐", "face": "https://i0.hdslb.com/bfs/face/de6afbda484e114b7cedeb621c3cbbaef7800988.jpg", "fans": 0, - "official_verify_type": -1 + "name": "不谦易会社恐", + "official_verify_type": -1, + "uid": "1602175830" }, { - "uid": 155817540, - "uname": "社会易总", - "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", + "face": "http://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 8, - "official_verify_type": -1 + "name": "社会易总", + "official_verify_type": -1, + "uid": "155817540" }, { - "uid": 3546578331634371, - "uname": "社会存在与社会易逝", "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会存在与社会易逝", + "official_verify_type": -1, + "uid": "3546578331634371" }, { - "uid": 1983403996, - "uname": "社会易姐QAQ", - "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", + "face": "http://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易姐QAQ", + "official_verify_type": -1, + "uid": "1983403996" }, { - "uid": 408471763, - "uname": "社会易大佬人狠话不多", - "face": "https://i1.hdslb.com/bfs/face/510cde8f4e3eb27aa50177d619a4200bb501797b.jpg", + "face": "http://i1.hdslb.com/bfs/face/510cde8f4e3eb27aa50177d619a4200bb501797b.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易大佬人狠话不多", + "official_verify_type": -1, + "uid": "408471763" }, { - "uid": 384672256, - "uname": "社会易轩", - "face": "https://i1.hdslb.com/bfs/face/7324adb53362527a1bf5f20141a6ae4307011ea7.jpg", + "face": "http://i1.hdslb.com/bfs/face/7324adb53362527a1bf5f20141a6ae4307011ea7.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易轩", + "official_verify_type": -1, + "uid": "384672256" }, { - "uid": 284984452, - "uname": "社会易哥", - "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", + "face": "http://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易哥", + "official_verify_type": -1, + "uid": "284984452" }, { - "uid": 249112673, - "uname": "社会易姐", - "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", + "face": "http://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易姐", + "official_verify_type": -1, + "uid": "249112673" }, { - "uid": 167967213, - "uname": "社会易大佬", - "face": "https://i0.hdslb.com/bfs/face/member/noface.jpg", + "face": "http://i0.hdslb.com/bfs/face/member/noface.jpg", "fans": 0, - "official_verify_type": -1 + "name": "社会易大佬", + "official_verify_type": -1, + "uid": "167967213" } ] } - ], - "_gt_": 0 + ] } } ``` diff --git a/docs/user/info.md b/docs/user/info.md index 33f5dbddf1..58c416999d 100644 --- a/docs/user/info.md +++ b/docs/user/info.md @@ -937,24 +937,22 @@ curl -G 'https://api.bilibili.com/x/space/myinfo' \ *请求方式:GET* -可以同时获取较多的用户信息(据测试可以一次性获取 2000 多个用户的信息;若获取更多用户信息可能会返回 -504 `服务调用超时`) - **url参数:** -| 参数名 | 类型 | 内容 | 必要性 | 备注 | -| ------ | ---- | ----------------- | ------ | ------------------- | -| uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔 | +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ------ | ---- | ----------------- | ------ | ---------------------------------- | +| uids | nums | 目标用户的mid列表 | 必要 | 每个成员间用`,`分隔,最多200个成员 | **json回复:** 根对象: -| 字段 | 类型 | 内容 | 备注 | -| ------- | ----- | -------- | --------------------------- | -| code | num | 返回值 | 0:成功
-400:请求错误 | -| message | str | 错误信息 | 默认为0 | -| ttl | num | 1 | | -| data | obj | 信息本体 | 用户信息随机排序 | +| 字段 | 类型 | 内容 | 备注 | +| ------- | ----- | -------- | -------------------------------------------------------- | +| code | num | 返回值 | 0:成功
-400:请求错误
40143:批量大小超过限制 | +| message | str | 错误信息 | 默认为0 | +| ttl | num | 1 | | +| data | obj | 信息本体 | 用户信息随机排序 | `data`对象: