php github api

PHP GitHub API

GitHub API 的简单面向对象包装器，用 PHP 编写。

使用 GitHub API v3 并支持 GitHub API v4。对象 API (v3) 与 RESTful API 非常相似。

特征

• 由于 API 类的延迟加载，轻便且快速
• 经过广泛测试和记录

要求

• PHP >= 7.2
• PSR-17 实施
• PSR-18 实施

快速安装

通过作曲家。

此命令将使您能够快速启动并运行 Guzzle HTTP 客户端。

composer require knplabs/github-api:^3.0 guzzlehttp/guzzle:^7.0.1 http-interop/http-factory-guzzle:^1.0

高级安装

在 HTTPlug 的帮助下，我们与任何 HTTP 消息传递客户端解耦。

使用不同的 http 客户端

composer require knplabs/github-api:^3.0 symfony/http-client nyholm/psr7

使用此 HTTP 客户端设置 Github 客户端

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

$ client = Client:: createWithHttpClient ( new HttplugClient ());

在我们的文档中阅读有关使用不同客户端的更多信息。

框架集成

拉维尔

为了将该库集成到 Laravel 中，Graham Campbell 创建了 graham-campbell/github。请参阅安装说明以开始使用 Laravel。

php-github-api客户端的基本使用

 <?php

// This file is generated by Composer
require_once __DIR__ . ' /vendor/autoload.php ' ;

$ client = new  Github  Client ();
$ repositories = $ client -> api ( ' user ' )-> repositories ( ' ornicar ' );

从$client对象，您可以访问所有可用的 GitHub api 端点。

缓存使用情况

此示例使用 PSR6 缓存池 redis-adapter。请参阅 http://www.php-cache.com/ 了解替代方案。

 <?php

// This file is generated by Composer
require_once __DIR__ . ' /vendor/autoload.php ' ;

use Cache  Adapter  Redis  RedisCachePool ;

$ client = new  Redis ();
$ client -> connect ( ' 127.0.0.1 ' , 6379 );
// Create a PSR6 cache pool
$ pool = new RedisCachePool ( $ client );

$ client = new  Github  Client ();
$ client -> addCache ( $ pool );

// Do some request

// Stop using cache
$ client -> removeCache ();

使用缓存，如果资源自上次以来没有发生变化，客户端将获得缓存的响应，而不会达到 github 施加的X-Rate-Limit 。

文档

请参阅doc目录以获取更详细的文档。

执照

php-github-api已根据 MIT 许可证获得许可 - 有关详细信息，请参阅许可证文件

维护者

请先阅读这篇文章。

该库由以下人员维护（按字母顺序排列）：

• @杂技演员
• @尼霍尔姆

贡献者

• 感谢 Thibault Duplessis 又名。 ornicar 的这个库的第一个版本。
• 感谢约瑟夫·比拉夫斯基（又名）。感谢斯特劳德的贡献和支持。
• 感谢 noloh 对对象 API 的贡献。
• 感谢 bshaffer 对 Repo API 的贡献。
• 感谢 Rolf van de Krol 做出的无数贡献。
• 感谢 Nicolas Pastorino 对 Pull Request API 的贡献。
• 感谢 Edoardo Rivello 对 Gists API 的贡献。
• 感谢 Miguel Piedrafita 对 v4 和 Apps API 的贡献。
• 感谢 Emre DEGER 对 Actions API 的贡献。

感谢 GitHub 提供的高质量 API 和文档。