* chore(deps): bump the docs group in /website with 6 updates Bumps the docs group in /website with 6 updates: | Package | From | To | | --- | --- | --- | | [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus) | `2.4.3` | `3.0.0` | | [@docusaurus/plugin-client-redirects](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-client-redirects) | `2.4.3` | `3.0.0` | | [@docusaurus/plugin-pwa](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-pwa) | `2.4.3` | `3.0.0` | | [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) | `2.4.3` | `3.0.0` | | [@docusaurus/module-type-aliases](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-module-type-aliases) | `2.4.3` | `3.0.0` | | [@docusaurus/types](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-types) | `2.4.3` | `3.0.0` | Updates `@docusaurus/core` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus) Updates `@docusaurus/plugin-client-redirects` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-plugin-client-redirects) Updates `@docusaurus/plugin-pwa` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-plugin-pwa) Updates `@docusaurus/preset-classic` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-preset-classic) Updates `@docusaurus/module-type-aliases` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-module-type-aliases) Updates `@docusaurus/types` from 2.4.3 to 3.0.0 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.0.0/packages/docusaurus-types) --- updated-dependencies: - dependency-name: "@docusaurus/core" dependency-type: direct:production update-type: version-update:semver-major dependency-group: docs - dependency-name: "@docusaurus/plugin-client-redirects" dependency-type: direct:production update-type: version-update:semver-major dependency-group: docs - dependency-name: "@docusaurus/plugin-pwa" dependency-type: direct:production update-type: version-update:semver-major dependency-group: docs - dependency-name: "@docusaurus/preset-classic" dependency-type: direct:production update-type: version-update:semver-major dependency-group: docs - dependency-name: "@docusaurus/module-type-aliases" dependency-type: direct:development update-type: version-update:semver-major dependency-group: docs - dependency-name: "@docusaurus/types" dependency-type: direct:development update-type: version-update:semver-major dependency-group: docs ... Signed-off-by: dependabot[bot] <support@github.com> * chore: fix dependencies * docs: fix admonition caution is deprecated in v3 caution(v2 yellow) => warning(v3 yellow) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
# API
|
|
|
|
:::warning
|
|
|
|
API 仍处于开发状态中,并可能会有改动。欢迎提供建议!
|
|
|
|
:::
|
|
|
|
RSSHub 提供下列 API:
|
|
|
|
## 可用公共路由列表
|
|
|
|
:::tip
|
|
|
|
`protected_router.js`下的路由**不会被**包含在此 API 返回的结果当中.
|
|
|
|
:::
|
|
|
|
举例: [https://rsshub.app/api/routes/bilibili](https://rsshub.app/api/routes/bilibili)
|
|
|
|
路由: `/api/routes/:name?`
|
|
|
|
参数:
|
|
|
|
- `name`, 路由一级名称,对应 [https://github.com/DIYgod/RSSHub/tree/master/lib/routes](https://github.com/DIYgod/RSSHub/tree/master/lib/routes) 中的文件夹名称。可选,**缺省则返回所有可用路由**.
|
|
|
|
成功请求将会返回 HTTP 状态码 `200 OK` 与 JSON 结果,格式如下:
|
|
|
|
```js
|
|
{
|
|
"status": "success",
|
|
"data": {
|
|
"bilibili": {
|
|
"routes": [
|
|
"/bilibili/user/video/:uid",
|
|
"/bilibili/user/article/:uid",
|
|
"/bilibili/user/fav/:uid",
|
|
"/bilibili/user/coin/:uid",
|
|
"/bilibili/user/dynamic/:uid",
|
|
"/bilibili/user/followers/:uid",
|
|
"/bilibili/user/followings/:uid",
|
|
"/bilibili/user/channel/collections/:uid/:sid",
|
|
"/bilibili/user/channel/series/:uid/:sid",
|
|
"/bilibili/partion/:tid",
|
|
"/bilibili/partion/ranking/:tid/:days?",
|
|
"/bilibili/bangumi/:seasonid",
|
|
"/bilibili/video/page/:aid",
|
|
"/bilibili/video/reply/:aid",
|
|
"/bilibili/link/news/:product",
|
|
"/bilibili/live/room/:roomID",
|
|
"/bilibili/live/search/:key/:order",
|
|
"/bilibili/live/area/:areaID/:order",
|
|
"/bilibili/fav/:uid/:fid",
|
|
"/bilibili/blackboard",
|
|
"/bilibili/mall/new",
|
|
"/bilibili/mall/ip/:id",
|
|
"/bilibili/ranking/:rid?/:day?",
|
|
"/bilibili/topic/:topic"
|
|
]
|
|
}
|
|
},
|
|
"message": "request returned 22 routes"
|
|
}
|
|
```
|
|
|
|
若无符合请求路由,请求将会返回 HTTP 状态码 `204 No Content`.
|