Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.82 KB

README.md

File metadata and controls

73 lines (48 loc) · 3.82 KB

🌸 AnimeGarden

version AnimeGarden Deploy Worker CI

English | 简体中文

動漫花園 第三方 镜像站 以及 动画 BT 资源聚合站.

  • ☁️ 为开发者准备的开放 API 接口
  • 📺 查看 动画放送时间表 来找到你喜欢的动画
  • 🔖 支持丰富的高级搜索, 例如: 葬送的芙莉莲 +简体内嵌 字幕组:桜都字幕组 类型:动画
  • 📙 自定义 RSS 订阅链接, 例如: 葬送的芙莉莲
  • ⭐ 搜索条件收藏夹和生成聚合的 RSS 订阅链接
  • 👷‍♂️ 支持与 AutoBangumiAnimeSpace 集成

home

API 的使用

curl "https://garden.breadio.wiki/api/resources?page=1&pageSize=10"

你可以在这里找到交互式的 Open API 文档, 以及在本仓库的 scripts/api.http 文件内查看到更多 API 用例.

如果你正在使用 JavaScript 和 TypeScript 进行开发, 那么你可以直接使用 npm 包 animegarden, 它是对这些 API 请求的上层封装.

npm 包的使用

它是 AnimeGarden 的 JavaScript / TypeScript 的 API 客户端封装.

npm i animegarden
import { fetchResources } from 'animegarden'

// Fetch the first page of Anime Garden mirror site
const resources = await fetchResources(fetch)

// Fetch all the resources which match some filter conditions
const sakurato = await fetchResources(fetch, { count: -1, fansub: 619 })

使用时, 你需要保证你的程序环境中有内置的 Fetch 函数. 如果没有, 你可以安装使用 undici 或者 ofetch.

你可以在这里查看更多过滤条件 FilterOptions, 也可以在 ./scripts/ 目录下找到更多程序示例.

本地开发

参考 CONTRIBUTING.md 中的描述配置环境和开始开发.

相关项目

  • AnimeSpace: Keep following your favourite anime
  • Anitomy: A TypeScript port of Anitomy inspired by AnitomySharp.
  • bgmc: Bangumi Data / API Clients

鸣谢

开源协议

MIT License © 2023 XLor