@ikenxuan/amagi

快速开始

抖音、B站、快手、小红书 Web 端相关数据接口的 Node.js 封装与服务

本文档适用于 v6 测试版。如需使用稳定版,请参考 v5 文档

本项目专为 karin-plugin-kkk 服务

amagi 作为 karin-plugin-kkk 的核心数据层,以 Git 子模块方式提供多平台数据获取能力。功能迭代主要围绕 karin-plugin-kkk 的业务需求进行。

如需其他接口支持,请参考开发文档自行封装,或提交 Pull Request 贡献代码。

特性

  • 多平台支持:抖音、B站、快手、小红书的主流数据接口
  • 两种使用姿势
    • 直接调用:通过 SDK 获取数据,支持绑定 Cookie
    • 本地服务:一键启动 Express 服务,REST 风格路由
  • 参数校验:基于 Zod,按方法类型校验必填与可选参数
  • 统一响应:约定化 ApiResponse 返回结构,含 success/code/message/data
  • 类型模式strictloose 可选,开发友好与容错可控
  • 工具集齐全:签名算法、URL 拼接器、AV/BV 转换等常用工具
  • 双模块输出:同时支持 ESM 与 CJS 引入

快速开始

相关链接

本文档由 AI 辅助生成,可能存在描述不准确、示例代码过时或遗漏关键信息等问题。如发现错误或疑问,请以实际代码实现为准,或提交 Issue 反馈。

On this page