如何利用Composer集成 PHP-GitHub-Api 库调用 GitHub 开放平台接口

小明大大_9545

小明大大_9545

2026-07-04

725人浏览

原创

必须配置personal access token和user-agent头,否则易触发401/403错误;需注意php版本兼容性(^3.5适配php 7.4–8.1)、分页参数per_page/page、速率限制及异常类型精准捕获。

如何利用composer集成 php-github-api 库调用 github 开放平台接口

直接用 composer require 安装 php-github-api/php-github-api 就能调用 GitHub API,但默认配置下容易 403、401 或返回空数据——根本原因是 GitHub 自 2021 年起强制要求所有 API 请求带 Authorization 头,且多数写操作(如创建 issue、push commit)必须用 Personal Access Token(PAT),不能用密码或基础认证。

安装时确认版本兼容 PHP 和 GitHub API v3

该库已停止维护(最后发布是 2022 年的 v3.5.0),但它仍稳定支持 GitHub REST API v3。不推荐拉 dev-main 或高版本分支,因为与 PHP 8.2+ 的类型声明冲突风险高。

执行以下命令即可:

composer require php-github-api/php-github-api:^3.5

注意检查你的 PHP 版本:

  • PHP 7.4–8.1:用 ^3.5 安全
  • PHP 8.2+:避免 ^3.6 及以上(存在 ReturnTypeWillChange 报错)
  • 若项目已用 Laravel,别用 laravel/socialite 混搭——它不提供底层 API 调用能力,只是 OAuth 登录封装

初始化 Client 必须传入 token,且不能省略 user-agent

GitHub API 明确要求每个请求含 User-Agent 头,否则直接 403;未授权时返回 401,但错误信息极简(只有 {"message":"Bad credentials"}),容易误判为网络问题。

正确初始化方式:

$client = new \Github\Client();
$client->authenticate('ghp_xxx...', \Github\Client::AUTH_HTTP_TOKEN);
$client->setUserAgent('my-app-name/1.0'); // 必须设,值可任意但不能为空

常见错误:

Digital Clawatar
Digital Clawatar

通过 UNITH API 创建、配置和管理 UNITH 数字人形象,价格低于 HeyGen 等,适用于用户想要创建…

下载
  • 漏掉 setUserAgent() → 403 Forbidden,无提示原因
  • 用 AUTH_URL_TOKEN(已废弃)→ 认证失败且不报错,后续调用静默返回空数组
  • token 权限不足(比如只勾了 public_repo 却想读 org secrets)→ 404 或 403,不是 401

调用 issues、repos 等接口时注意分页和速率限制

GitHub 默认每页最多 30 条,且未显式传 per_page 参数时就用这个值;rate_limit 剩余数藏在响应头里,不主动查会突然被限流(HTTP 403 + X-RateLimit-Remaining: 0)。

推荐写法:

// 获取前 100 个 issue(需分两页)
$issues = $client->api('issue')->all('owner', 'repo', ['state' => 'all', 'per_page' => 100, 'page' => 1]);
// 检查是否还有更多
$remaining = (int) $client->getHttpClient()->getLastResponse()->getHeader('X-RateLimit-Remaining')[0];

关键点:

  • 所有列表接口(api('repo')->all()、api('user')->repositories())都支持 per_page 和 page 参数,但不支持 limit 这种 Laravel 风格参数
  • 搜索接口(如 api('search')->repositories())走的是另一套规则,q 参数必须 URL 编码,且不支持字段级过滤(例如不能直接 q=language:php stars:>100 得手动拼)
  • 上传 release asset 用 api('repo')->releases()->assets()->upload(),但必须先拿到 upload_url(含临时 token),不能直接 POST 到 releases 接口

调试时优先看响应头和异常类型,别只盯 body

这个库抛出的异常类型很具体,比 raw cURL 更易定位问题:

  • \Github\Exception\RuntimeException:网络超时、DNS 失败等底层错误
  • \Github\Exception\ErrorException:API 返回非 2xx 状态码(如 404 repo not found)
  • \Github\Exception\BadCredentialsException:明确 token 错误或过期

建议加一层兜底日志:

try {
    $data = $client->api('user')->show();
} catch (\Github\Exception\BadCredentialsException $e) {
    error_log('GitHub token invalid or expired: ' . $e->getMessage());
} catch (\Github\Exception\ErrorException $e) {
    error_log('GitHub API error ' . $e->getCode() . ': ' . $e->getMessage());
    // 查看完整响应头
    $headers = $client->getHttpClient()->getLastResponse()->getHeaders();
}

真正难排查的不是“调不通”,而是“调通了但数据不对”——比如用组织名当 owner 却没开 SSO 授权,或 token 没勾选 read:org 却去查 org 成员列表,此时返回空数组而非报错。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer php git github

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9464

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5701

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2055

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3548

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4234

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3311

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4717

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3682

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11702

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习