mirror of
https://github.com/DIYgod/RSSHub.git
synced 2025-12-05 04:11:26 +08:00
5012e71c87
* Format doc * Update api.md * Add <code> tag for <route> and fix English documentation * Update docs/parameter.md Co-authored-by: Tony <TonyRL@users.noreply.github.com> * Update docs/parameter.md Co-authored-by: Tony <TonyRL@users.noreply.github.com> Co-authored-by: Tony <TonyRL@users.noreply.github.com>
1.1 KiB
1.1 KiB
API
::: warning Warning The API is under active development and is subject to change. All suggestions are welcome! :::
RSSHub provides the following APIs:
List of Public Routes
::: tip Tip
This API will not return any routes under lib/protected_router.js.
:::
Eg: https://rsshub.app/api/routes/github
Route: /api/routes/:name?
Parameters:
name, route's top level name as in https://github.com/DIYgod/RSSHub/tree/master/lib/routes. Optional, returns all public routes if not specified.
A successful request returns a HTTP status code 200 OK with the result in JSON:
{
"status": "success",
"data": {
"github": {
"routes": [
"/github/trending/:since/:language?",
"/github/issue/:user/:repo",
"/github/user/followers/:user",
"/github/stars/:user/:repo"
]
}
},
"message": "request returned 4 routes"
}
If no matching results were found, the server returns only a HTTP status code 204 No Content.