Files
Wrangler-API/README.md
Jurangren 65855b64c1 feat: 添加 Docker 支持及 GitHub Actions 自动构建流
*   新增 Dockerfile,支持在 Node.js 环境下本地运行 API。
*   添加 GitHub Actions 工作流,实现镜像自动构建并推送到 Docker Hub。
*   支持多平台构建(linux/amd64, linux/arm64)。
*   在 README.md 中补充了 Docker 本地运行的操作指南。
2025-12-20 08:54:48 +08:00

64 lines
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Wrangler-API
Cloudflare Workers 版 SearchGal 聚合搜索 API。提供 `/gal``/patch` 两个入口,接收游戏名并以 SSE 流式返回各平台搜索结果。
## 准备
- Node.js 18+npm
- Cloudflare 账号(发布时需要)
## 安装
```bash
npm install
```
## 本地开发
- 纯本地(无 Cloudflare 登录):`npx wrangler dev --local`
- 实时连 Cloudflare`npx wrangler dev`
## 发布
```bash
npx wrangler login # 首次需要
npx wrangler publish
```
## Docker
### 本地运行
```bash
docker build -t wrangler-api:local .
docker run --rm -p 8787:8787 wrangler-api:local
```
## API 使用
- 路径:`POST /gal``POST /patch`
- Content-Type`multipart/form-data`
- 表单字段:`game` (string)
- 响应:`text/event-stream`,每行是一条 JSON示例
```
{"total":33}
{"progress":{"completed":1,"total":33}}
{"progress":{"completed":2,"total":33},"result":{"name":"某平台","color":"lime","tags":["NoReq"],"items":[{"name":"Title","url":"https://..."}]}}
{"done":true}
```
## 标签说明tags
- `NoReq`:无需登录/回复即可拿到下载信息
- `Login`:需登录后访问
- `LoginPay`:需登录且支付积分
- `LoginRep`:需登录并回复/评论解锁
- `Rep`:需回复/评论但无需登录
- `SuDrive`:自建网盘盘源
- `NoSplDrive`不限速网盘盘源如Onedrive/Mega等
- `SplDrive`:限速网盘盘源(如百度/夸克/天翼等)
- `MixDrive`:不限速与限速网盘盘源混合,可能提供多种下载形式
- `BTmag`BT或磁力链接
- `magic`:站点需要代理访问
## 目录速览
- `src/index.ts` Worker 入口,路由 `/gal``/patch`
- `src/core.ts` 处理并行搜索与 SSE 组装
- `src/platforms/gal` GAL 平台搜集器
- `src/platforms/patch` 补丁平台搜集器
- `src/utils/httpClient.ts` 统一请求封装
- `scripts/generate-indices.js` 可选的索引生成脚本