php github api

PHP-GitHub-API

Ein einfacher objektorientierter Wrapper für die GitHub-API, geschrieben mit PHP.

Verwendet GitHub API v3 und unterstützt GitHub API v4. Die Objekt-API (v3) ist der RESTful-API sehr ähnlich.

Merkmale

• Leicht und schnell dank verzögertem Laden von API-Klassen
• Umfangreich getestet und dokumentiert

Anforderungen

• PHP >= 7.2
• Eine PSR-17-Implementierung
• Eine PSR-18-Implementierung

Schnelle Installation

Über Komponist.

Mit diesem Befehl können Sie schnell mit einem Guzzle-HTTP-Client arbeiten.

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

Erweiterte Installation

Mit Hilfe von HTTPlug sind wir von jedem HTTP-Messaging-Client entkoppelt.

Verwendung eines anderen http-Clients

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

So richten Sie den Github-Client mit diesem HTTP-Client ein

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

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

Weitere Informationen zur Verwendung verschiedener Clients finden Sie in unseren Dokumenten.

Framework-Integrationen

Laravel

Um diese Bibliothek in Laravel zu integrieren, hat Graham Campbell graham-campbell/github erstellt. Sehen Sie sich die Installationsanweisungen an, um mit Laravel zu beginnen.

Grundlegende Verwendung des php-github-api Clients

 <?php

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

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

Vom $client Objekt aus haben Sie Zugriff auf alle verfügbaren GitHub-API-Endpunkte.

Cache-Nutzung

In diesem Beispiel wird der Redis-Adapter des PSR6-Cache-Pools verwendet. Alternativen finden Sie unter 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 ();

Mithilfe des Cache erhält der Client zwischengespeicherte Antworten, wenn sich die Ressourcen seit dem letzten Mal nicht geändert haben, ohne dass das von Github festgelegte X-Rate-Limit erreicht wird.

Dokumentation

Ausführlichere Dokumentation finden Sie im doc -Verzeichnis.

Lizenz

php-github-api ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der LICENSE-Datei

Betreuer

Bitte lesen Sie zuerst diesen Beitrag.

Diese Bibliothek wird von folgenden Personen gepflegt (alphabetisch sortiert):

• @Akrobat
• @Nyholm

Mitwirkende

• Vielen Dank an Thibault Duplessis aka. ornicar für seine erste Version dieser Bibliothek.
• Danke an Joseph Bielawski aka. Stloyd für seine Beiträge und Unterstützung.
• Vielen Dank an noloh für seinen Beitrag zur Objekt-API.
• Vielen Dank an bshaffer für seinen Beitrag zur Repo-API.
• Vielen Dank an Rolf van de Krol für seine unzähligen Beiträge.
• Vielen Dank an Nicolas Pastorino für seinen Beitrag zur Pull Request API.
• Vielen Dank an Edoardo Rivello für seinen Beitrag zur Gists API.
• Vielen Dank an Miguel Piedrafita für seinen Beitrag zur v4 & Apps API.
• Vielen Dank an Emre DEGER für seinen Beitrag zur Actions API.

Vielen Dank an GitHub für die hochwertige API und Dokumentation.