Consumet 文档网站是什么?

docs.consumet.org 是 Consumet 项目的官方文档站。Consumet 本身是一组高层搜索引擎 API 的集合,用来查询动漫、漫画、轻小说、电影等多种娱乐媒介的信息,并返回指向公开在线来源的流媒体链接。这个文档站的作用,是说明如何使用 Consumet 的 API(api.consumet.org)以及配套的 TypeScript 库(@consumet/extensions)。

它提供什么

根据文档首页的介绍,Consumet 的定位可以拆成两层:

  • 信息查询层:通过 API 获取动漫、漫画、轻小说、电影等娱乐内容的准确信息。
  • 链接获取层:返回可在线播放这些内容的流媒体链接,来源是公开可访问的在线资源。

文档站同时覆盖两种使用方式:

使用方式 入口 适合谁
HTTP API api.consumet.org 任何语言的项目,直接发请求即可
TypeScript 库 @consumet/extensions Node.js / TypeScript 项目,希望以库的形式调用

文档站的结构

文档站的核心内容是按 provider(提供方)组织的文档集合。首页明确写着这是“每个 provider 的文档集合”,并附有一份 provider 列表。也就是说,不同内容源被拆成独立的 provider,每个 provider 有自己的文档页,说明它支持哪些查询、返回什么。

这种组织方式意味着:你要查某个具体功能,通常不是翻一份大而全的 API 手册,而是先确定用哪个 provider,再看对应页面。

适合什么场景

  • 想给自己的应用接入动漫、漫画、轻小说、电影等内容的搜索与信息展示。
  • 想以编程方式获取这些内容的在线播放链接。
  • 使用 TypeScript / Node.js,想直接引入 @consumet/extensions 而不是自己封装 HTTP 请求。

使用前需要知道的前提

文档站本身只说明“怎么用”,不承诺内容来源的稳定性。它描述的流媒体链接来自公开在线来源,因此链接是否长期有效、某个 provider 是否仍然可用,取决于上游来源的状态,而不是文档能保证的。实际接入时,建议先确认目标 provider 当前是否可用,再决定是否把它作为依赖。

另外,输入资料中没有提到价格、付费计划或登录要求,因此无法判断 API 是否需要密钥或存在调用限制。接入前应自行查阅文档中对应 provider 的说明,确认访问条件。

docs.consumet.org
A collection of documentation for each provider available on Consumet. Find out how to efficiently use the Consumet API here!