启用use-github-api可使Composer通过HTTPS下载ZIP包而非调用Git命令，适用于无Git客户端或网络受限环境。1. 该选项让Composer请求GitHub API获取分支或标签的ZIP下载链接并解压，跳过git clone；2. 可在composer.json中配置use-github-api为true以全局启用，或结合repositories为特定VCS源设置；3. 推荐配合github-protocols使用HTTPS协议，并配置github-oauth令牌提升API调用限额；4. 通过composer install -v可验证是否从https://api.github.com/repos/.../zipball/下载，确认生效。
使用 Composer 时，如果你希望避免直接调用 Git 命令（例如 clone 或 pull），而是通过 GitHub 的 API 来下载代码包，可以配置 use-github-api 选项。这个设置能让 Composer 通过 HTTPS 下载 ZIP 归档文件，而不是依赖本地的 Git 客户端。
这在某些受限环境（如 CI/CD 环境无 Git 安装、网络限制 Git 协议）中非常有用，也能提升安装速度并减少对 Git 的依赖。
1. 配置 use-github-api 的作用
use-github-api 是 Composer 对 GitHub 包的一种优化机制：
- 启用后，Composer 会向
api.github.com发起请求获取指定分支或标签的 ZIP 包下载链接 - 然后直接下载压缩包并解压，跳过 git clone 过程
- 适用于所有托管在 GitHub 上的私有或公开仓库（通过 VCS 类型定义）
2. 全局或项目级配置方式
你可以在 composer.json 中为特定仓库显式启用该选项，或通过 config 设置影响行为。
当你通过 repositories 添加一个 GitHub 的 VCS 源时，可以附加配置：
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/vendor/private-repo",
"options": {
"http": {
"header": [
"Authorization: token YOUR_GITHUB_TOKEN"
]
}
}
}
],
"require": {
"vendor/private-repo": "dev-main"
},
"config": {
"use-github-api": true
}
}
注意：use-github-api 是全局 config 项，设置为 true 后 Composer 会优先尝试用 API 下载 ZIP。
"config": {
"use-github-api": true,
"github-protocols": ["https"]
}
- use-github-api: true — 强制使用 GitHub API 获取 ZIP
- github-protocols: ["https"] — 禁用 git:// 协议，确保走 HTTPS
3. 使用 GitHub Token 提高限流容忍度
GitHub 对未认证的 API 请求有严格限流（通常 60 次/小时）。建议配置访问令牌：
"config": {
"github-oauth": {
"github.com": "your-personal-access-token"
},
"use-github-api": true
}
这样 Composer 能以更高限额访问 API，避免 API limit exceeded 错误。
4. 验证是否生效
运行安装命令时加上 -v 查看详细输出：
composer install -v
如果看到类似日志：
Downloading https://api.github.com/repos/vendor/repo/zipball/...
说明已成功通过 GitHub API 下载，未执行 git clone。
基本上就这些。开启 use-github-api 并配合 OAuth Token，可有效避免 Git 操作，提升稳定性和兼容性。
