better-github-api

Better, Eazy, Access Anywhere

介绍

基于 gh-proxy + Jsdelivr + cnpmjs + cloudflare workers 的 GitHub Serverless API 工具。

cdn.js：仅含 gh-proxy 中的CDN功能，URL后加上GitHub各种资源（源码、Release文件等）的下载链接跳转为对应CDN加速的链接。

api.js：本项目的核心，提供API服务，部署时只用修改最开始的几个变量参数。

问题

• GitHub资源下载龟速，你我都有办法，但是用户没有，而分发存储到其他地方也可能会增加开支和麻烦。
• GitHub的API没有办法直接获得 Release 的某个附件，如提供过滤选项在众多Assets中筛选想要的附件，获取最新版本的某个附件只能通过解析API进一步操作，而实际应提供一个固定、简短的API。
• Jsdelivr很好用，可结合GitHub Actions自动搬运资源，但是有~20MB/文件限制。

优势

• 使用 Jsdelivr 等CDN加速资源下载，Release文件加速无大小限制；
• 提供简明的API，可作为程序分发的固定下载链接；
• 开销低，每个账号CloudFlare Workers 免费请求额度为 ~1k次/小时 ~100k次/天，5$付费版 ~10m次/天，且可开多个账号。

如需用自己的域名，应使用CloudFlare的DNS服务（maybe可用CNAME跳转Worker的域名）

路线

• repo
• get
• bucket
• submit
• list
• submit可视化提交界面

使用

如果有配置好的API服务可以直接使用，API参考这里，这里给出可用的域名，请尽量自己搭建减少这里的压力，毕竟是免费的，也可提交你的域名：

• https://api.upup.cool
• ...

下面是使用举例：

部署

登录 Cloudflare Workers 注册，登陆，选择Workers，创建Worker。下面的服务可自由选择。

CDN服务

1. 复制项目文件中cdn.js的内容到左侧代码框；
2. 修改 ASSET_URL, Config, PREFIX；
3. 保存并部署；
4. （可选）修改Worker的域名/路由。

API服务

1. 复制项目文件中api.js的内容到左侧代码框，保存并部署；
2. 修改 ASSET_URL, Config, PREFI；
3. 修改 HOME_PAGE，请求不加参数时跳转到主页；
4. 保存并部署；
5. 返回Workers界面，点击KV设置命名空间，添加两个命名空间：KV、BUCKET（可修改），回到Worker的设置页绑定命名空间，注意变量名称必须是KV 、BUCKET；
6. 提交KV键值对：给刚才绑定KV变量名的命名空间添加键值对（仓库简称-值）以使用get方法，参照这里；
7. （可选）修改Worker的域名/路由。

配置参数说明：

ASSET_URL 修改为Worker的域名，如用自定义域名也要改成对应的。

↓一般不用改

Config clone是否使用cnpm，项目文件是否使用jsDeliver的开关，1开，0关。

PREFIX 前缀，，默认（根路径情况为"/"），如果自定义路由为example.com/gh/*，请将PREFIX改为 '/gh/'，注意，少一个杠都会错！

域名修改说明：

如果有自己的域名，可以给CDN和API服务分配分配到两个子域名中。使用CloudFlare做域名的DNS服务器之后，按下表设置DNS：

然后在域名设置页找到Workers，添加路由，路由格式：

api.upup.cool/*
cdn.upup.cool/*

API设计

KV（Key-Value）键值对：CloudFlare提供了免费1GB的键值对存储功能，可以设置多个命名空间，Workers可以读写这些键值实现一些功能

一级API

二级API

/repo

filter用&分隔的过滤器各个部分，必须&开头，格式为 &include&exclude&start&end ，可用格式的示例如下：

• &hlae&&&.zip
• &HLAE_Setup.exe
• &HLAE_Setup.exe&&&
• &hlae&.exe
• &hlae&.exe&&

右侧连通的空白部分&可省去。

/get

仓库简称后的API与repo一致，区别在使用KV存储的信息（仓库主、仓库名、filter等）简化API。

至于KV里如何存简称-全称的对应关系：

举例：键为 hlae，值为：

{
	"repo": "advancedfx/advancedfx",
	"filter": "&hlae&&&.zip",
	"info": {
		"zh_CN": "hlae的zip安装包",
		"zh_TW": "hlae的zip安裝包"
	}
}

之后使用URL如https://api.upup.cool/get/hlae即可直接下载hlae的最新zip安装包，同时包含CDN服务，避免了很多访问速度的问题。

/bucket （未完成）

/submit（未完成）