新增接口
学习如何为平台新增数据接口
新增接口
本文档以 B站为例,演示如何新增一个平台接口。
需要修改的文件
新增一个接口需要修改以下文件:
| 序号 | 文件 | 作用 |
|---|---|---|
| 1 | types/BilibiliAPIParams.ts | 定义参数类型 |
| 2 | validation/bilibili.ts | 参数验证 Schema + 路由映射 |
| 3 | platform/bilibili/API.ts | URL 拼接 |
| 4 | platform/bilibili/getdata.ts | 数据获取逻辑 |
| 5 | types/ReturnDataType/Bilibili/index.ts | 返回类型(可选) |
| 6 | model/fetchers/bilibili/types.ts | Fetcher 类型 |
| 7 | model/fetchers/bilibili/*.ts | Fetcher 实现 |
| 8 | model/fetchers/bilibili/index.ts | 导出 |
完整示例:新增「获取视频标签」接口
特殊情况处理
验证修改
在提交前,请确保:
# 1. 类型检查通过
pnpm typecheck
# 2. 构建成功
pnpm build
# 3. 功能测试
pnpm dev
# 然后手动测试新增的接口