php github api

PHP API GitHub

Простая объектно-ориентированная оболочка для GitHub API, написанная на PHP.

Использует GitHub API v3 и поддерживает GitHub API v4. Объектный API (v3) очень похож на RESTful API.

Функции

• Легко и быстро благодаря ленивой загрузке классов API.
• Всесторонне протестировано и задокументировано

Требования

• PHP >= 7.2
• Реализация PSR-17
• Реализация PSR-18

Быстрая установка

Через Композитор.

Эта команда поможет вам быстро приступить к работе с HTTP-клиентом Guzzle.

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

Расширенная установка

Мы отделены от любого клиента обмена сообщениями HTTP с помощью HTTPlug.

Использование другого http-клиента

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

Чтобы настроить клиент Github с помощью этого HTTP-клиента

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

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

Подробнее об использовании различных клиентов читайте в нашей документации.

Интеграция фреймворков

Ларавел

Чтобы интегрировать эту библиотеку в laravel, Грэм Кэмпбелл создал 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 у вас есть доступ ко всем доступным конечным точкам API GitHub.

Использование кэша

В этом примере используется адаптер redis-адаптера кэш-пула PSR6. См. 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 ();

Используя кеш, клиент будет получать кешированные ответы, если ресурсы не изменились с прошлого раза, не достигая предела X-Rate-Limit установленного github.

Документация

Более подробную документацию смотрите в каталоге doc .

Лицензия

php-github-api лицензируется по лицензии MIT — подробности см. в файле ЛИЦЕНЗИИ.

Мейнтейнеры

Пожалуйста, сначала прочитайте этот пост.

Эту библиотеку поддерживают следующие люди (в алфавитном порядке):

• @acrobat
• @Нюхольм

Авторы

• Спасибо Тибо Дюплесси, он же. ornicar для своей первой версии этой библиотеки.
• Спасибо Джозефу Белявскому, он же. stloyd за его вклад и поддержку.
• Спасибо noloh за его вклад в Object API.
• Спасибо bshaffer за его вклад в API Repo.
• Спасибо Рольфу ван де Кролу за его бесчисленный вклад.
• Спасибо Николасу Пасторино за его вклад в API запросов на извлечение.
• Спасибо Эдоардо Ривелло за его вклад в API Gists.
• Спасибо Мигелю Пьедрафите за его вклад в v4 и Apps API.
• Спасибо Эмре ДЕГЕРУ за его вклад в Actions API.

Спасибо GitHub за качественный API и документацию.