duncan3dc/github

镜像概述

本Docker镜像封装了用于与GitHub API交互的PHP库，旨在简化PHP应用程序对GitHub资源的操作。通过该镜像，开发者可快速集成GitHub API功能，实现对仓库、用户、issues、pull requests等GitHub资源的查询、创建、更新与管理，无需手动配置PHP环境及依赖。

核心功能与特性

1. 全面的API支持

• 完整覆盖GitHub API v3（REST API）及部分v4（GraphQL API）端点，支持仓库管理、用户信息查询、组织操作、事件监听等核心功能。

2. 简洁的接口设计

• 提供直观的PHP面向对象接口，封装复杂API调用逻辑，降低开发难度。例如通过$client->repositories()->listUserRepos('username')即可获取用户仓库列表。

3. 灵活的认证机制

• 支持多种认证方式：个人访问令牌（Personal Access Token）、OAuth2令牌、基本认证（用户名/密码），满足不同场景下的权限需求。

4. 完善的错误处理

• 内置异常处理机制，自动捕获API返回的错误状态码（如401未授权、404资源不存在），并转换为可识别的PHP异常，便于问题排查。

5. 响应数据格式化

• 自动将API返回的JSON数据转换为PHP数组或对象，支持自定义数据解析规则，提升数据处理效率。

使用场景与适用范围

适用场景

• 开发集成工具：构建与GitHub联动的开发辅助工具（如自动部署脚本、代码质量检查工具）。
• 项目管理系统：在项目管理平台中集成GitHub issues、pull requests管理功能。
• 数据分析平台：采集GitHub仓库数据（如贡献者统计、代码提交频率）进行分析。
• 自动化脚本：编写定时任务脚本，自动同步GitHub数据至本地系统。

适用人群/团队

• PHP开发者及开发团队
• 需要快速集成GitHub功能的中小企业开发团队
• 开源项目维护者（用于构建项目周边工具）

使用方法与配置说明

1. 获取镜像

从Docker仓库拉取镜像（假设镜像名称为github-api-php-client）：

bash
docker pull github-api-php-client:latest

2. 环境变量配置

运行容器时需通过环境变量传入必要参数，核心配置如下：

3. 基本使用示例

3.1 单容器运行

挂载本地PHP脚本目录至容器，执行API调用脚本：

bash
docker run -it --rm \
  -v $(pwd)/scripts:/app \
  -e GITHUB_TOKEN="your_github_personal_token" \
  github-api-php-client:latest \
  php /app/your_script.php

3.2 docker-compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  github-api-client:
    image: github-api-php-client:latest
    volumes:
      - ./scripts:/app
    environment:
      - GITHUB_TOKEN=your_github_personal_token
      - API_VERSION=v3
    command: php /app/your_script.php

启动服务：

bash
docker-compose up

4. PHP代码示例

在挂载的scripts目录下创建example.php，编写API调用代码：

php
<?php
// 初始化客户端（容器内已自动加载库，无需额外require）
$client = new GithubApiClient([
    'token' => getenv('GITHUB_TOKEN'),
    'api_version' => getenv('API_VERSION'),
    'timeout' => getenv('REQUEST_TIMEOUT')
]);

// 示例1：获取指定用户的公开仓库列表
try {
    $repos = $client->repositories()->listUserRepos('octocat');
    print_r("用户octocat的仓库列表：");
    print_r($repos);
} catch (Exception $e) {
    echo "获取仓库失败：" . $e->getMessage();
}

// 示例2：创建issue
try {
    $issue = $client->issues()->create('owner/repo', [
        'title' => '测试Issue',
        'body' => '通过PHP库创建的测试Issue'
    ]);
    echo "Issue创建成功，编号：" . $issue['number'];
} catch (Exception $e) {
    echo "创建Issue失败：" . $e->getMessage();
}
?>

5. 错误处理

库会抛出以下常见异常，可通过try-catch捕获处理：

• AuthException：认证失败（如token无效）
• ResourceNotFoundException：请求的资源不存在（404）
• RateLimitException：API调用频率超限（403）
• ApiException：其他API错误（如参数错误、服务器错误）

示例：

php
try {
    // API调用代码
} catch (AuthException $e) {
    echo "认证失败，请检查GITHUB_TOKEN是否有效";
} catch (RateLimitException $e) {
    echo "API调用频率超限，请稍后重试";
}