From 41d73f1a20d856ffc5468243fbf17e5a35dc1a92 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: Fri, 20 Sep 2024 21:22:06 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=B7=BB=E5=8A=A0=E6=B6=88=E6=81=AF?= =?UTF-8?q?=E4=B8=AD=E5=BF=83=E6=8E=A5=E5=8F=A3=E7=9B=B8=E5=85=B3=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=20(#983)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update charge_list.md * Update charge_msg.md * Update relation.md * Update relation.md * update * Update monthly.md * Update monthly.md * update * Update charge_list.md * Update relation.md * Update monthly.md * Update README.md * Update charge_list.md * update * Update relation.md * Update relation.md * Update relation.md * Update info.md * update * update * rename * update docs * update * update * update * update * add more docs * update docs * 更新 private_msg.md * Update Layout.vue * Update README.md * 添加 #1008 相关说明 * Update README.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update private_msg.md * fix: typo * update docs * feat: #1033 * update docs * fix: typo * Update private_msg.md * feat: add get users info * 将 #983 中对此文件的更改合并到此 PR 中 * fix: typo * update docs * Update private_msg_content.md * Update info.md * 更新 danmaku_view_proto.md * 更新 action.md * 更新 info.md * 更新 recommend.md * 更新 readme.md * feat: 规范化文档 * Update private_msg_content.md * update docs * update docs * update docs * Update info.md * update docs * fix duplicate content --- CONTRIBUTING.md | 156 +-- README.md | 113 +- docs/history&toview/history.md | 4 + docs/message/msg.md | 42 +- docs/message/private_msg.md | 1508 +++++++++++++++++++++++---- docs/message/private_msg_content.md | 627 +++++++++++ 6 files changed, 2099 insertions(+), 351 deletions(-) create mode 100644 docs/message/private_msg_content.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bbaf4049fc..6c283a69b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,41 @@ -# bilibili-API-collect +# 贡献指南 欢迎来到 bilibili-API-collect 社区贡献指南，本文主要面向需要进行提交贡献文档内容的用户。 ## 总则 -[bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) 项目（简称 BAC 或 b-a-c）是一个仅用于学习研究、社区开源、公益性质的 [B站（哔哩哔哩）](https://www.bilibili.com/) API（应用程序接口） 文档，使用 [CC-BY-NC 4.0 协议](https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE) 开源，它将无差别收集整理相关的**主站业务接口**。 +[bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) 项目（简称 BAC 或 b-a-c）是一个仅用于学习研究、社区开源、公益性质的 [B 站（哔哩哔哩）](https://www.bilibili.com/)API（应用程序接口）文档，使用 [CC-BY-NC 4.0 协议](https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE)开源，它将无差别收集整理相关的**主站业务接口**。 -该项目使用 [MarkDown](https://zh.wikipedia.org/zh-cn/Markdown) 语法进行文档书写，按照业务类型及功能以 **路径** + **文件** 形式索引，任何用户都可通过 Pull Request 提供自己分析出的接口地址与使用说明。 +该项目使用 [MarkDown](https://zh.wikipedia.org/zh-cn/Markdown) 语法进行文档书写，按照业务类型及功能以**路径**＋**文件**形式索引，任何用户都可通过 Issue、Pull Request 与 Discussion 提供自己分析出的接口地址与使用说明。 -本项目收集的接口类型包括但不限于 REST API、gRPC、WebSocket，文档内统一优先使用安全套接字协议，如`https`、`securityRpc`、`wss`。 +本项目收集的接口类型包括但不限于 REST API、gRPC、WebSocket，文档内统一优先使用安全套接字协议，如 `https`、`securityRpc`、`wss`。 -## Issue与社群讨论 +## Issue、Discussion 与社群讨论 -对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**，可直接提出，强烈建议以发 **Issue** 的形式参与用户反馈，并希望关于本项目的各种交流都是**公开进行**的，因为这样才可以保证关键信息的一致性。 +对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**，可直接提出，强烈建议以提交 **Issue** 的形式添加 / 补充 / 更新文档中的说明，以发起 **Discussion** 的形式提出问题、代码用例、情报分享，并希望关于本项目的各种交流都是**公开进行**的，因为这样才可以保证关键信息的一致性。 -由于本项目属于文档型项目，故不设置 Issue 模板，同时允许中英文标题，但提交 Issue 请遵守以下原则： +提交 Issue 请遵守以下原则： -1. 标题言简意骇，说明欲提出的问题要点，如`如何通过xx接口获取yy`、`xx接口地址已失效`、`关于xx字段意义的探讨`、` 建议将xx加入yy分类`等标题；切勿使用表意含糊不清或索取性的标题，如`怎么解决风控`、`补充`、`搜索的接口是什么`、`好兄弟有没有投稿的接口`等标题 -2. Issue 正文应对问题进行尽可能详细的描述，展开并聚焦有关的信息，例如：“在前端页面某地址 / APP 某界面会访问某 API（标明地址），它的某参数与文档中不符（标明文档地址）” -3. 提出问题时注意 [提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md) 并且 [别像弱智一样提问](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways) +1. 标题需要点明 API 的用处，如 `[新增请求] 新增 xx 接口`、`[更新请求] xx 接口地址已失效`、`[更新请求] xx 接口的参数有变化`，切勿仅填写 `补充`、`修复` 等标题 +2. 正文请按照 Issue 模板进行填写，标明 API 来源（Web、Android、iOS、TV 等）、API 类型（REST、gRPC、WebSocket 等）、API 地址 +3. 详情描述需要提供该 API 的使用场景、请求及响应字段等，可附上原始抓包记录；在更新时还需指出原文档中与最新 API 行为不符之处，并附上已知的最新改动。例如：“在前端页面某地址 / APP 某界面访问某 API（标明地址），它的某参数与文档中不符（标明文档地址）” + +发起 Discussion 请遵守以下原则： + +1. 标题言简意骇，说明欲提出的问题要点，如 `如何通过 xx 接口获取 yy`、`关于 xx 字段意义的探讨`、`建议将 xx 加入 yy 分类` 等标题；切勿使用表意含糊不清或索取性的标题，如 `怎么解决风控`、`搜索的接口是什么`、`好兄弟有没有投稿的接口` 等标题 +2. Discussion 正文应对遇到的问题进行尽可能详细的描述，展开并聚焦有关的信息，例如： “按照文档中某位置的说明进行了某操作，为什么无法获得预期结果”、“请问某 API 的某字段的具体含义是什么” +3. 提出问题时注意[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)并且[别像弱智一样提问](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways) 同时，您还可以通过加入社群的方式参与讨论 -- QQ 交流群：[邀请链接](https://jq.qq.com/?_wv=1027&k=s1M0LCcu) +- QQ 交流群：[邀请链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=ympvb3LAPT-Ulu3ezhGqbkJ8zXMKImOX&authKey=z1KdkOdKO3wytN43m9K6On9nBtnDL4pAoD6VQHCipFBb9TasNDKuDHCmOE6TF3uc&noverify=0&group_code=191187164) - Telegram 交流群：[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community) ::: tip ✅提示 QQ 交流群为综合技术交流群（兼 Owner 的粉丝群），可交流探讨任何技术，包括但不限于 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect) -Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect) 的 Github Bot 接收，也可以进行项目相关的讨论，但不建议在此讨论交流其他内容（公开群） +Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect)的 Github Bot 接收，也可以进行项目相关的讨论，但不建议在此讨论交流其他内容（公开群） ::: @@ -37,13 +43,13 @@ Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bi 群内讨论同样需要遵守**公开交流**的原则，以及群内会定期清理不活跃成员。 -**QQ 交流群** 的加群问题答案可以去 [Owner 的主页](https://github.com/SocialSisterYi) Contact 部分找到，如果您填写“我不知道，从 Github 来的“那么管理员将有理由禁止您进群讨论！ +**QQ 交流群**的加群问题答案可以去 [Owner 的主页](https://github.com/SocialSisterYi) Contact 部分找到，如果您填写“我不知道，从 Github 来的”那么管理员将有理由禁止您进群讨论！ ::: ::: danger 🈲禁止 -项目 Issue 及其相关社群中 **禁止** 询问讨论 风控解除、爬虫（采集）、破解、漏洞利用、买卖代码和账号 相关内容，抵制基于本项目进行的一切黑产行为！ +项目 Issue 及其相关社群中**禁止**询问讨论 风控解除、爬虫（采集）、破解、漏洞利用、买卖代码和账号 相关内容，抵制基于本项目进行的一切黑产行为！ ::: @@ -51,28 +57,29 @@ Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bi ### 目录 -文档目录以 **Markdown无序列表** 语法写在 [README.md](README.md) 中，使用缩进标识文档的层级，如`视频`下存在`基本信息`、`快照`、`推荐`等子分类，使用 **Markdown 复选框** 语法该标注文档是否编写完成 +文档目录以 **Markdown 无序列表**语法写在 [README.md](README.md) 中，使用缩进标识文档的层级，如 `视频` 下存在 `基本信息`、`快照`、`视频推荐`、`TAG` 等子分类，使用 **Markdown 复选框**语法该标注文档是否编写完成 ```markdown -- [x] 视频 +- [ ] 视频 - [x] 基本信息 - [x] 快照 - - [x] 推荐 + - [x] 视频推荐 + - [ ] TAG ``` ### 路径 -路径层级应当与文档目录一致，以文件夹的形式存放在项目中的`/docs`路径下，命名统一使用英文，如`video`、`danmaku`、`comment` +路径层级应当与文档目录一致，以文件夹的形式存放在项目中的 `/docs` 路径下，命名统一使用英文小写，如 `video`、`danmaku`、`comment` -二级、三级路径应当存在二级三级目录，以`README.md`的形式 +二级、三级路径应当存在二级三级目录，可选添加 `README.md` 以描述该子目录 ### 文件 -各个子接口集整理为 md 文件，命名统一使用英文，如`info.md`、`action.md`、`list.md` +各个子接口集整理为 MarkDown（md）文件，命名统一使用英文小写，如 `info.md`、`action.md`、`list.md` -文档文件中用于存放相关的接口的说明，如`video/`下的`info.md`，存在`查询视频基本信息`、`查询视频简介`、`查询视频分P列表`等内容 +文档文件中用于存放相关的接口的说明，如 `video/` 下的 `info.md`，存在 `查询视频基本信息`、`查询视频简介`、`查询视频分P列表` 等内容 -## Markdown文档内容格式 +## Markdown 文档内容格式 文档使用 [Vuepress](https://vuepress.vuejs.org/) 生成，可以使用 [Vuepress md 扩展语法](https://vuepress.vuejs.org/guide/markdown.html)编写 @@ -80,25 +87,25 @@ Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bi ### 头部 -文档首行为 **一级标签** 格式标题 +文档首行为**一级标签**格式标题，如 `# 用户基本信息` -**文档头部不再需要手写索引** +**文档头部不再需要手写索引**，索引由 Vuepress 自动生成 ### 接口说明 文档中可存在多个接口说明，应当遵守同一范式，依次排列在文档中 -接口说明分为`标题`、`地址`、`说明`、`请求参数`、`响应正文`、`示例`这些部分 +接口说明分为 `标题`、`地址`、`说明`、`请求参数`、`响应正文`、`示例` 这些部分 -接口标题为 **二级以下** 的标签，接口地址使用 **引用** 语法，地址只保留 REST API 路径，不应携带 query 等内容 +接口标题为**二级以下**的标签，接口地址使用**引用**语法，地址只保留 REST API 路径，不应携带 query 等内容 -接口地址下方需要注明接口的请求方式，如`GET`、`POST`、`PUT`等，使用 **斜体** 语法 +接口地址下方需要注明接口的请求方式，如 `GET`、`POST`、`PUT` 等，使用*斜体*语法 -若接口存在认证或鉴权，需要在说明中注明，如`Cookie(SESSDATA)`、`APP`（认证是针对用户的，鉴权是针对接口使用的 +若接口存在认证或鉴权，需要在说明中注明，如 `Cookie (SESSDATA)`、`APP`（认证是针对用户的，鉴权是针对接口使用的） -其他使用说明也可写在这里，如`限制游客访问的视频需要登录` +其他使用说明也可写在这里，如 `限制游客访问的视频需要登录` -eg： +e.g.： ```markdown ## 获取视频详细信息_web端 @@ -107,84 +114,84 @@ eg： *请求方式：GET* -认证方式：Cookie(SESSDATA) +认证方式：Cookie (SESSDATA) 限制游客访问的视频需要登录 ``` -**请求参数**应在**接口说明**的下方，应注明参数类型 url 参数或 正文参数（正文参数应注明 content-type，如`application/x-www-form-urlencoded`或`multipart/form-data`），使用 **加粗** 语法 +**请求参数**应在**接口说明**的下方，应注明参数类型 url 参数或正文参数（正文参数应注明 content-type，如 `application/x-www-form-urlencoded` 或 `multipart/form-data`），使用**加粗**语法 -对象的字段及其含义使用 **表格** 进行整理，表头统一为`参数名`、`类型`、`内容`、`必要性`、`备注`，类型为`num`、`str`、`bool`、`nums`、`strs`、`file`等，必要性为`必要`、`非必要`、`必要(可选)`等，表格内每个字段为一行 +对象的字段及其含义使用**表格**进行整理，表头统一依次为 `参数名`、`类型`、`内容`、`必要性`、`备注`，类型为 `num`、`str`、`bool`、`nums`、`strs`、`file` 等，必要性为 `必要`、`非必要`、`必要 (可选)` 等，表格内每个字段为一行 -eg： +e.g.： | 参数名 | 类型 | 内容 | 必要性 | 备注 | | ------ | ---- | --------- | ----------- | ----------------- | | aid | num | 稿件 avid | 必要 (可选) | avid 与 bvid 任选 | | bvid | str | 稿件 bvid | 必要 (可选) | avid 与 bvid 任选 | -**响应正文**应在**请求参数**的下方，接口响应的数据格式应标注，如`JSON回复`、`XML回复`、`Protobuf回复`，使用 **加粗** 语法 +**响应正文**应在**请求参数**的下方，接口响应的数据格式应标注，如 `JSON 回复`、`XML 回复`、`ProtoBuf 回复`，使用**加粗**语法 -json object 或 protobuf message 应以对象的 **表格** 形式书写，表头为`根对象`或`xx中的yy对象`，若对象位于数组中为`xx数组中的对象` +JSON Object 或 ProtoBuf Message 应以对象的**表格**形式书写，表头为 `根对象` 或 `xx 中的 yy 对象`，若对象位于数组中则为 `xx 数组中的对象` -表头统一为`字段`、`类型`、`内容`、`备注`，类型为 JSON / Protobuf 的标准类型 +表头统一依次为 `字段`、`类型`、`内容`、`备注`，类型为 JSON / Protobuf 的标准类型，如 `num`、`str`、`bool`、`obj`、`array`、`null` 等 -不明确定义的字段说明在末尾添加问号，如`播放数？`；定义尚未明确的字段使用问号包于括号中占位，如`（？）` +不明确定义的字段说明在内容的末尾添加问号，如 `播放数？`；定义尚未明确的字段使用 `（？）` 在内容中占位，并在备注中填写 `作用尚不明确` 多个对象及数组，使用**遍历树**的顺序进行排列 -eg： +e.g.： -`data`对象： +`data` 对象： -| 字段 | 类型 | 内容 | 备注 | -| ------ | ---- | ----------- | -------- | -| bvid | str | 稿件 bvid | | -| aid | num | 稿件 avid | | -| videos | num | 稿件分P总数 | 默认为 1 | -| tid | num | 分区 tid | | +| 字段 | 类型 | 内容 | 备注 | +| -------- | ---- | ----------- | ------------ | +| bvid | str | 稿件 bvid | | +| aid | num | 稿件 avid | | +| videos | num | 稿件分P总数 | 默认为 1 | +| tid | num | 分区 tid | | +| no_cache | bool | （？） | 作用尚不明确 | -json array 或 protobuf repeated 类型使用数组的 **表格** 形式书写，表头统一为`项`、`类型`、`内容`、`备注`，无限长度数组表尾需要添加**省略号** +Json Array 或 ProtoBuf Repeated 类型使用数组的**表格**形式书写，表头统一依次为 `项`、`类型`、`内容`、`备注`，无限长度数组表尾需要添加**省略号** -数组每项内容若与实际数据有关联，`内容`字段则可标为`(n+1)P 视频内容`这样的形式 +数组每项内容若与实际数据有关联，`内容` 字段则可标为 `(n+1)P 视频内容` 这样的形式 -eg： +e.g.： -`data`中的`pages`数组： +`data` 中的 `pages` 数组： | 项 | 类型 | 内容 | 备注 | | ---- | ---- | --------------- | ------------- | -| 0 | obj | 1P 视频内容 | 无分P仅有此项 | +| 0 | obj | 1P 视频内容 | 无分 P 仅有此项 | | n | obj | (n+1)P 视频内容 | | | …… | obj | …… | …… | **示例**部分位于所有**响应正文**部分下方，需要**加粗**格式，分为请求命令示例与响应体示例两部分 -请求命令示例为一段可测试该接口的 curl 命令或 Python 脚本，使用 **代码块** 语法书写，命令应当尽可能简短、便于使人阅读 +请求命令示例为一段可测试该接口的 curl 命令或 Python 脚本，使用**代码块**语法书写，命令应当尽可能简短、便于使人阅读 -示例命令中的认证信息应做**脱敏处理**，如 Cookie、Token、access_key 等，可替换为`xxx`占位 +示例命令中的认证信息应做**脱敏处理**，如 Cookie、Token、access_key 等，可替换为 `xxx` 占位 示例命令前后可以适当添加一些文字说明 -响应体示例为一段格式化后的 JSON 或 protobuf message，使用 **代码块** 语法书写，并使用`
`标签进行折叠 +响应体示例为一段格式化后的 JSON 或 ProtoBuf Message，使用**代码块**语法书写，并使用 `
` 标签进行折叠 -eg： +e.g.： +````markdown **示例：** -获取视频`av85440373`的基本信息 +获取视频 `av85440373` 的基本信息 ```shell curl -G 'https://api.bilibili.com/x/web-interface/view' \ --data-urlencode 'aid=85440373' ``` -```html
查看响应示例： -``` -```json +```jsonc { "code": 0, "message": "0", @@ -196,37 +203,38 @@ curl -G 'https://api.bilibili.com/x/web-interface/view' \ "tid": 28, "tname": "原创音乐", "copyright": 1, - ... + // ... + } +} ``` -```html
-``` +```` ### 枚举值与属性位 -接口返回或请求中若存在一些 enum 类型或二进制属性位，应当单独进行探讨，如视频的属性位`attribute`或视频清晰度`qn` +接口返回或请求中若存在一些 enum 类型或二进制属性位，应当单独进行探讨，如视频的属性位 `attribute` 或视频清晰度 `qn` -这些值及其说明使用 **表格** 进行整理，表头统一为`位` / `代码` / `值`、`含义`、`备注` +这些值及其说明使用**表格**进行整理，表头统一为 `位` / `代码` / `值`、`含义`、`备注` 这些枚举值或属性位的用法应附加文字说明 -eg： +e.g.： | 值 | 含义 | 备注 | | ---- | ------------- | ------------------------------------------------------------ | -| 6 | 240P 极速 | 仅 MP4 格式支持
仅`platform=html5`时有效 | +| 6 | 240P 极速 | 仅 MP4 格式支持
仅 `platform=html5` 时有效 | | 16 | 360P 流畅 | | | 32 | 480P 清晰 | | -| 64 | 720P 高清 | WEB 端默认值
B站前端需要登录才能选择，但是直接发送请求可以不登录就拿到 720P 的取流地址
**无 720P 时则为 720P60** | -| 74 | 720P60 高帧率 | 登录认证 | -| 80 | 1080P 高清 | TV 端与 APP 端默认值
登录认证 | +| 64 | 720P 高清 | WEB 端默认值
B 站前端需要登录才能选择，但是直接发送请求可以不登录就拿到 720P 的取流地址
**无 720P 时则为 720P60** | +| 74 | 720P60 高帧率 | 需要登录认证 | +| 80 | 1080P 高清 | TV 端与 APP 端默认值
需要登录认证 | -## Proto定义格式 +## Proto 定义格式 proto 文件为 [Protocol Buffers](https://protobuf.dev/) 以及 [gRPC](https://grpc.io/docs/) 的数据结构体定义，多用于客户端的接口，本文档也做相关的收集 -存放于项目的`/grpc_api`路径下，使用包名进行路径层级的组织，如 +存放于项目的 `/grpc_api` 路径下，使用包名进行路径层级的组织，如： ``` /grpc_api/bilibili/main/community/reply/v1/reply.proto @@ -234,7 +242,7 @@ proto 文件为 [Protocol Buffers](https://protobuf.dev/) 以及 [gRPC](https:// /grpc_api/bilibili/app/view/v1/view.proto ``` -proto 文件内使用 **单行注释** 标注字段或对象的含义，如 +proto 文件内使用**单行注释**标注字段或对象的含义，如： ```protobuf // UP主信息 @@ -250,4 +258,6 @@ message Author { ## 文档提交 -TODO +使用 Pull Request 将修改后的文档提交到 `master` 分支，标题需写明提交的内容 + +（TODO） diff --git a/README.md b/README.md index fe436d467b..25ba6489bb 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,41 @@

-

哔哩哔哩-API收集整理

+

哔哩哔哩 - API 收集整理

- - GitHub issues + + GitHub issues - - GitHub stars + + GitHub stars - - GitHub forks + + GitHub forks - - + + Build status - - GitHub license + + GitHub license

- SocialSisterYi%2Fbilibili-API-collect | Trendshift + Trendshift

-

野生API文档

+

野生 API 文档

不断更新中....

-本项目旨在对 B站 WEB、APP、TV 等客户端中，散落在世界各地的野生 API 进行收集整理，研究使用方法并对其进行说明，运用了黑箱法、控制变量法、代码逆向分析、拆包及反编译法、网络抓包法等研究办法 +本项目旨在对 B 站 WEB、APP、TV 等客户端中，散落在世界各地的野生 API 进行收集整理，研究使用方法并对其进行说明，运用了黑箱法、控制变量法、代码逆向分析、拆包及反编译法、网络抓包法等研究办法 本文档探讨的对象是主站业务接口，[官方开放平台](https://openhome.bilibili.com/doc) 和 [直播开放平台](https://open-live.bilibili.com/document/) 均不属于本项目范畴，请移步 B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接口为 WebSocket；REST API 接口请求数据大多为 url query 表单或 JSON，返回数据大多为 JSON 或 Protobuf，强制使用 https 协议 -📖阅读地址：[GithubPages](https://socialsisteryi.github.io/bilibili-API-collect/) +📖阅读地址：[Github Pages](https://socialsisteryi.github.io/bilibili-API-collect/) -小小的 Demo：~~av583785685~~ [视频失效原因](https://shakaianee.top/archives/56/) ([Youtube备链](https://www.youtube.com/watch?v=nfF91Z6fqGk)) +小小的 Demo：~~av583785685~~ [视频失效原因](https://shakaianee.top/archives/56/) ([Youtube 备链](https://www.youtube.com/watch?v=nfF91Z6fqGk)) ::: warning ⚠️声明 @@ -64,7 +64,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 计划整理分类 & 目录：(文档已完结请选中 checkbox) - [ ] [接口签名与验证](docs/misc/sign) - - [x] [APP API 签名](docs/misc/sign/APP.md)（`appkey`与`sign`） + - [x] [APP API 签名](docs/misc/sign/APP.md)（`appkey` 与 `sign`） - [x] [已知的 APPKey](docs/misc/sign/APPKey.md) - [x] [Wbi 签名](docs/misc/sign/wbi.md)（`wts`与`w_rid`） - [ ] [bili_ticket](docs/misc/sign/bili_ticket.md) @@ -74,7 +74,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [x] [公共错误码](docs/misc/errcode.md) - [x] [图片格式化](docs/misc/picture.md) - [x] [bvid 说明](docs/misc/bvid_desc.md) - - [ ] [设备唯一标识BUVID](docs/misc/device_identity.md) + - [ ] [设备唯一标识 BUVID](docs/misc/device_identity.md) - [ ] [获取 buvid3 / buvid4 / b_nut](docs/misc/buvid3_4.md) - [ ] [b23.tv 短链](docs/misc/b23tv.md) - [ ] [gRPC API 接口定义](grpc_api) @@ -92,6 +92,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [ ] [消息中心](docs/message) - [ ] [通知类消息](docs/message/msg.md) - [ ] [私信](docs/message/private_msg.md) + - [ ] [私信消息类型、内容说明](docs/message/private_msg_content.md) - [ ] 设置 - [ ] [用户](docs/user) - [x] [基本信息](docs/user/info.md) @@ -116,20 +117,20 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [x] [点赞 & 投币 & 收藏 & 分享](docs/video/action.md) - [ ] [TAG](docs/video/tags.md) - [x] [视频推荐](docs/video/recommend.md) - - [x] [播放&下载地址 (视频流)](docs/video/videostream_url.md) + - [x] [播放 & 下载地址 (视频流)](docs/video/videostream_url.md) - [ ] [互动视频](docs/video/interact_video.md) - [x] [高能进度条](docs/video/pbp.md) - [ ] [信息上报 (心跳及记录历史)](docs/video/report.md) - [x] [视频属性数据](docs/video/attribute_data.md) - [x] [视频在线人数](docs/video/online.md) - - [x] [视频AI摘要](docs/video/summary.md) + - [x] [视频 AI 摘要](docs/video/summary.md) - [ ] [稿件投诉](docs/video/appeal.md) - [ ] [视频状态数](docs/video/status_number.md) - [ ] [视频合集](docs/video/collection.md) - [ ] [播放器](docs/video/player.md) - [ ] [剧集 (番剧、影视)](docs/bangumi) - [ ] [基本信息](docs/bangumi/info.md) - - [ ] [播放&下载地址（视频流）](docs/bangumi/videostream_url.md) + - [ ] [播放 & 下载地址（视频流）](docs/bangumi/videostream_url.md) - [ ] [时间轴](docs/bangumi/timeline.md) - [ ] [追番相关](docs/bangumi/follow.md) - [ ] 状态数 @@ -199,7 +200,7 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [ ] [充电](docs/electric) - [ ] [包月充电](docs/electric/monthly.md) - [ ] 自定义充电 - - [x] [B币方式充电](docs/electric/Bcoin.md) + - [x] [B 币方式充电](docs/electric/Bcoin.md) - [x] [微信 & 支付宝方式充电](docs/electric/WeChat&Alipay.md) - [x] [充电留言](docs/electric/charge_msg.md) - [x] [充电列表](docs/electric/charge_list.md) @@ -262,9 +263,9 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [x] [青少年模式](docs/teenager/teenager_mode.md) - [ ] 亲子平台 - [ ] 课堂模式 -- [ ] [B币钱包](docs/wallet/) +- [ ] [B 币钱包](docs/wallet/) - [ ] [基本信息](docs/wallet/info.md) - - [ ] B币充值 + - [ ] B 币充值 - [ ] 贝壳相关 - [ ] [哔哩哔哩漫画](docs/manga) - [ ] 用户信息 @@ -275,18 +276,18 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 - [x] [漫画赛季](docs/manga/Season.md) - [x] [漫读券/已购相关](docs/manga/User.md) - [x] [下载](docs/manga/Download.md) - - [x] [data.index解析](docs/manga/index_file.md) + - [x] [data.index 解析](docs/manga/index_file.md) - [ ] [获取轻享卡信息](docs/manga/light_card.md) - [ ] 哔哩哔哩游戏 - [ ] [终端网络查询](docs/clientinfo) - - [x] [基于 ip 的地理位置查询](docs/clientinfo/ip.md) + - [x] [基于 IP 的地理位置查询](docs/clientinfo/ip.md) - [ ] [客服中心](docs/customerservice) - [ ] [客服消息](docs/customerservice/msg.md) -- [ ] [web端组件](docs/web_widget) +- [ ] [web 端组件](docs/web_widget) - [x] [分区当日投稿数](docs/web_widget/zone_upload.md) - [x] [404 页漫画收集](docs/web_widget/404_manga.md) - [ ] [首页横幅头图](docs/web_widget/header.md) -- [ ] [APP端组件](docs/APP_widget) +- [ ] [APP 端组件](docs/APP_widget) - [x] [开屏图片 + 恰饭珍贵录像](docs/APP_widget/splash.md) - [ ] [获取最新 APP 版本](docs/APP_widget/ver.md) - [ ] [个性装扮](docs/garb) @@ -302,13 +303,13 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接 ## 📖相关协议基础 -http 协议：[传送门](https://www.cnblogs.com/an-wen/p/11180076.html) +HTTP 协议：[传送门](https://www.cnblogs.com/an-wen/p/11180076.html) -json 序列格式：[传送门](https://www.sojson.com/json/json_index.html) +JSON 序列格式：[传送门](https://www.sojson.com/json/json_index.html) -xml 序列格式：[传送门](https://www.w3school.com.cn/xml/xml_intro.asp) +XML 序列格式：[传送门](https://www.w3school.com.cn/xml/xml_intro.asp) -protobuf 序列格式：[传送门](https://www.jianshu.com/p/a24c88c0526a ) +ProtoBuf 序列格式：[传送门](https://www.jianshu.com/p/a24c88c0526a) ## 💦交流 @@ -339,11 +340,11 @@ OR Aifadian：[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE) - [fython/BilibiliAPIDocs](https://github.com/fython/BilibiliAPIDocs) - [czp3009/bilibili-api](https://github.com/czp3009/bilibili-api) - [Vespa314/bilibili-api](https://github.com/Vespa314/bilibili-api) -- [wnstar/bili-utils](https://github.com/wnstar/bili-utils) -- [lovelyyoshino/Bilibili-Live-API](https://github.com/lovelyyoshino/Bilibili-Live-API) -- [flaribbit/bilibili-manga-spider](https://github.com/flaribbit/bilibili-manga-spider) -- [simon300000/bili-api](https://github.com/simon300000/bili-api) -- [iyear/biligo](https://github.com/iyear/biligo) Bilibili API SDK in Golang +- [Pengfei00/bili-utils](https://github.com/Pengfei00/bili-utils): bilibili 工具箱 +- [lovelyyoshino/Bilibili-Live-API](https://github.com/lovelyyoshino/Bilibili-Live-API): Bilibili 直播/番剧 API 文档 +- [flaribbit/bilibili-manga-spider](https://github.com/flaribbit/bilibili-manga-spider): Bilibili 漫画爬虫 +- [simon300000/bili-api](https://github.com/simon300000/bili-api): Bilibili Node.js API +- [iyear/biligo](https://github.com/iyear/biligo): Bilibili API SDK in Golang - [bilibili-openplatform/demo](https://github.com/bilibili-openplatform/demo): 哔哩哔哩开放平台示例代码库 - [ddiu8081/blive-message-listener](https://github.com/ddiu8081/blive-message-listener): Bilibili-live danmu listener with type. Bilibili 直播间弹幕监听库，支持类型输出。 - [Nemo2011/bilibili-api](https://github.com/Nemo2011/bilibili-api): 哔哩哔哩常用API调用。支持视频、番剧、用户、频道、音频等功能。工具齐全。 @@ -352,25 +353,23 @@ OR Aifadian：[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE) ### 成品 - [NullPointerException/AnimePipe](https://codeberg.org/NullPointerException/AnimePipe): 功能完善的Android流媒体综合客户端，支持Bilibili, Youtube, NicoNico -- [3Shain/BiliChat](https://github.com/3Shain/BiliChat) : 基于h5的B站直播弹幕姬 -- [AncientLysine/BiliLocal](https://github.com/AncientLysine/BiliLocal):本地弹幕播放器 -- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku):bilibili 生放送（直播）录制 -- [otakustay/danmaku-to-ass](https://github.com/otakustay/danmaku-to-ass):A站B站弹幕转字幕文件 -- [bilibili-helper/bilibili-helper-o](https://github.com/bilibili-helper/bilibili-helper-o):哔哩哔哩 (bilibili.com) 辅助工具，可以下载视频，查询弹幕发送人以及一些十分实用的直播区功能。 -- [apachecn/BiliDriveEx](https://github.com/apachecn/BiliDriveEx):基于B站相簿上传的文件分块索引存储器 -- [apachecn/CDNDrive](https://github.com/apachecn/CDNDrive):基于B站相簿上传的文件分块索引存储器 -- [Hsury/BiliDrive](https://github.com/Hsury/BiliDrive):基于B站相簿上传的文件分块索引存储器 -- [Tsuk1ko/bilibili-live-chat](https://github.com/Tsuk1ko/bilibili-live-chat):无后端的仿 YouTube Live Chat 风格的简易 Bilibili 弹幕姬 -- [ironmanic/crawler_target_users_good](https://github.com/ironmanic/crawler_target_users_good):搜索bilibili特定视频，为评论 点赞，关注，私信，一体化服务 -- [dd-center/DDatElectron](https://github.com/dd-center/DDatElectron):DD@Home 分布式项目, 桌面客户端 -- [dd-center/vtbs.moe](https://github.com/dd-center/vtbs.moe):B站VTB数据中心 -- [catlair/BiliOutils](https://github.com/catlair/BiliOutils):利用Docker，青龙面板，以及各种云函数等实现 B 站每日自动投币，会员大积分，漫画阅读和抢兑，领取大会员福利，大会员月底给自己充电等。每天轻松获取65经验值。 -- [the1812/Bilibili-Evolved](https://github.com/the1812/Bilibili-Evolved):强大的哔哩哔哩增强脚本: 下载视频, 音乐, 封面, 弹幕 / 简化直播间, 评论区, 首页 / 自定义顶栏, 删除广告, 夜间模式 / 触屏设备支持 +- [3Shain/Comen](https://github.com/3Shain/Comen): 基于h5的B站直播弹幕姬 +- [AncientLysine/BiliLocal](https://github.com/AncientLysine/BiliLocal): 本地弹幕播放器 +- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku): bilibili 生放送（直播）录制 +- [otakustay/danmaku-to-ass](https://github.com/otakustay/danmaku-to-ass): A站B站弹幕转字幕文件 +- [bilibili-helper/bilibili-helper-o](https://github.com/bilibili-helper/bilibili-helper-o): 哔哩哔哩 (bilibili.com) 辅助工具，可以下载视频，查询弹幕发送人以及一些十分实用的直播区功能。 +- [apachecn/CDNDrive](https://github.com/apachecn/CDNDrive): 基于B站相簿上传的文件分块索引存储器 +- [Hsury/BiliDrive](https://github.com/Hsury/BiliDrive): 基于B站相簿上传的文件分块索引存储器 +- [Tsuk1ko/bilibili-live-chat](https://github.com/Tsuk1ko/bilibili-live-chat): 无后端的仿 YouTube Live Chat 风格的简易 Bilibili 弹幕姬 +- [ironmanic/crawler_target_users_good](https://github.com/ironmanic/crawler_target_users_good): 搜索bilibili特定视频，为评论 点赞，关注，私信，一体化服务 +- [dd-center/DDatElectron](https://github.com/dd-center/DDatElectron): DD@Home 分布式项目, 桌面客户端 +- [dd-center/vtbs.moe](https://github.com/dd-center/vtbs.moe): B站VTB数据中心 +- [the1812/Bilibili-Evolved](https://github.com/the1812/Bilibili-Evolved): 强大的哔哩哔哩增强脚本: 下载视频、音乐、封面、弹幕 / 简化直播间、评论区、首页 / 自定义顶栏、删除广告、夜间模式 / 触屏设备支持 - [xlzy520/bili-short-url](https://github.com/xlzy520/bili-short-url): 哔哩哔哩短链生成器 - [zjkwdy/bili_app_splash](https://github.com/zjkwdy/bili_app_splash): B站壁纸娘和开屏图自动下载，每天使用Actions自动同步 - [Jannchie/BiliOB](https://github.com/Jannchie/BiliOB): BiliOB观测者是一个观测B站UP主及视频数据变化，并予以分析的Web应用程序 - [biliob233/biliob233.github.io](https://github.com/biliob233/biliob233.github.io): ~~无可奉告~~ -- [biliup/biliup](https://github.com/biliup/biliup): 全自动录播、投稿工具，也支持twitch、ytb频道搬运。提供分p上传b站接口，腾讯云内网免流+大幅提速 +- [biliup/biliup](https://github.com/biliup/biliup): 全自动录播、投稿工具，支持录制直播弹幕，也支持Youtube、twitch直播回放列表自动搬运到B站 - [ddiu8081/bilicli](https://github.com/ddiu8081/bilicli): Bilibili-live danmu dashboard in your terminal. - [MotooriKashin/Bilibili-Old](https://github.com/MotooriKashin/Bilibili-Old): 恢复旧版Bilibili页面，为了那些念旧的人。 - [SocialSisterYi/bcut-asr](https://github.com/SocialSisterYi/bcut-asr): 使用必剪API的语音字幕识别 @@ -380,14 +379,10 @@ OR Aifadian：[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE) ### 其他 -- [kuresaru/geetest-validator](https://github.com/kuresaru/geetest-validator):geetest调试器 - -- [uw-labs/bloomrpc](https://github.com/uw-labs/bloomrpc): GUI Client for GRPC Services - +- [kuresaru/geetest-validator](https://github.com/kuresaru/geetest-validator): GeeTest 调试器 +- [bloomrpc/bloomrpc](https://github.com/bloomrpc/bloomrpc): GUI Client for GRPC Services - [grpc/grpc](https://github.com/grpc/grpc): The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#) - -- [quicktype](https://github.com/quicktype/quicktype) quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages.一键生成多种语言的json反序列化所需类,以便于快速反序列化, - 有网页版 +- [glideapps/quicktype](https://github.com/glideapps/quicktype): quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages. 一键生成多种语言的JSON反序列化所需类，以便于快速反序列化，有网页版