# GitHub Release API 包装器使用指南

本服务用于便捷地获取和下载 GitHub 仓库的最新 Release 资源.
请求别名或者通用仓库位置模式将返回对应仓库的最新发行版信息,
其中还会包含指向发行版产物资源的 order_name, 继续使用它作
为下层路径访问则会返回 HTTP:302 到对应的资源的下载链接.

注意, 最新发行版 API 不包含预发行版和草稿版.

## 通用仓库路径模式

1. 获取资源列表: GET /<name>/<repo>
2. 下载指定资源: GET /<name>/<repo>/<order_name>

## 预定义别名模式

只有被预定义了别名的仓库才能使用. 别名清单请访问 /alias 路径.

1. 获取资源列表: GET /<alias>
2. 下载指定资源: GET /<alias>/<order_name>

## 速率限制

GitHub API 本身带有速率限制, 大量使用时建议传入 GitHub 令牌,
该包装器会将你的 Authorization 标头透传给 GitHub. 如果无法
使用认证标头传入令牌, 也支持使用 URL 参数 token 来传入令牌.

* 创建 Classic 令牌: <https://github.com/settings/tokens>
* 使用令牌认证: <https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api>

## 安全和信任

永远不应该直接信任任何第三方, 跟随重定向之前应当检查一次最终
跳转地址是否符合预期.
比如使用 curl 的 -I 标志检查 location 标头, 必要时分离本服务.

## 建议一个别名

如果你有自己经常追踪和使用的 GitHub 仓库, 可以通过以下方式
提出一个别名建议, 别名会被公开展示在 /alias 清单中.

* 联系作者: <https://cx.ms>
* Telegram 讨论: <https://t.me/cxplayworld/6380>
* NodeSeek 讨论: <https://www.nodeseek.com/post-656314-1>
* Fediverse 讨论: <https://sir.social/@cxplay/statuses/01KM4H7Z0FN84VD6B6EWH3M8DM>
* Nostr 讨论: <nostr:nevent1qythwumn8ghj7un9d3shjtnr0pcxccte9ehhyee0qqsgdst8manrh5fkc28kdukk0gpy37gnfc3g4lgrtcnz5ujvtj3gdgc53m5cj>

## 用法示例

1. 检索出 fastfetch 的 linux amd64 最新发行版产物:
    curl -sL gh.cx.ms/fastfetch | grep 'linux.*amd64'
2. 获取最新的 Vaultwarden 源代码下载链接:
    curl -sIL gh.cx.ms/vaultwarden/zip | grep location
3. 获取最新的 ungoogled-chromium 的 Linux 预构建版本号:
    curl -L gh.cx.ms/chromium-portablelinux | grep name