如何开始使用 Consumet API 或 TypeScript 库
Consumet 提供两套使用方式:直接调用托管在 https://api.consumet.org 的 HTTP API,或在项目里安装 TypeScript 库 @consumet/extensions。开始之前需要先确定你要访问的内容类型(动漫、漫画、轻小说、电影等),再找到对应的 provider,因为具体用法写在每个 provider 的说明页面里,而不是集中在一处。
Consumet 是什么
根据文档首页的说明,Consumet 是一组高层搜索引擎 API,用于返回多种娱乐媒介的准确信息,并附带指向公开在线来源的播放或阅读链接。它覆盖的媒介包括动漫、漫画、轻小说、电影等。
文档同时服务于两类使用者:
- 想直接发 HTTP 请求调用 API 的人
- 想在 TypeScript 项目里引入
@consumet/extensions库的人
两个入口分别是什么
| 入口 | 形式 | 适合的场景 |
|---|---|---|
https://api.consumet.org |
托管 API | 不想自己部署、直接用 HTTP 请求取数据 |
@consumet/extensions |
TypeScript 库 | 在 TS/JS 项目里以代码方式调用,自行控制运行环境 |
文档没有说明这两个入口是否需要登录、是否有调用配额或费用,这些信息在给出的资料中未提及,使用前建议以文档页面当时的说明为准。
provider 是理解用法的关键
文档把 provider 作为组织单位:每个 provider 有独立的说明页面。也就是说,使用流程不是「学一套通用调用方式然后套用到所有内容」,而是:
- 确定你要的内容属于哪种媒介
- 在文档的 provider 列表里找到对应项
- 打开该 provider 的页面,按它写的方式调用
文档首页的 "List of Providers" 就是这份索引的入口。不同 provider 支持的媒介和背后的公开来源不同,所以参数、返回结构也会不同。
建议的上手顺序
- 先读文档首页的 Introduction,确认 API 与库两种方式的区别
- 浏览 provider 列表,定位你实际需要的那一个
- 在该 provider 页面里对照示例完成第一次请求或第一次库调用
- 验证结果:确认返回内容里包含你要的媒介信息以及可用的来源链接
常见卡点
- 跳过 provider 直接找通用用法:文档的结构是按 provider 展开的,通用调用说明并不能替代具体 provider 页面。
- 把 API 和库当成同一件事:两者入口不同,示例代码不能直接互换。
- 假设来源可用性:文档说明链接指向的是公开在线来源,实际可用性取决于这些来源本身。
如果你的目标是快速验证可行性,先用托管 API 发一次请求最省事;如果要把 Consumet 集成进现有 TypeScript 项目,则从 @consumet/extensions 入手,再回到对应 provider 页面确认调用细节。