php github api

API GitHub PHP

Un simple wrapper orienté objet pour l'API GitHub, écrit avec PHP.

Utilise l'API GitHub v3 et prend en charge l'API GitHub v4. L'API objet (v3) est très similaire à l'API RESTful.

Caractéristiques

• Léger et rapide grâce au chargement paresseux des classes API
• Largement testé et documenté

Exigences

• PHP >= 7.2
• Une implémentation PSR-17
• Une implémentation PSR-18

Installation rapide

Via Compositeur.

Cette commande vous permettra d'être opérationnel rapidement avec un client HTTP Guzzle.

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

Installation avancée

Nous sommes découplés de tout client de messagerie HTTP avec l'aide de HTTPlug.

Utiliser un autre client http

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

Pour configurer le client Github avec ce client HTTP

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

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

En savoir plus sur l’utilisation de différents clients dans nos documents.

Intégrations de framework

Laravel

Pour intégrer cette bibliothèque dans Laravel, Graham Campbell a créé graham-campbell/github. Consultez les instructions d'installation pour démarrer dans Laravel.

Utilisation de base du client 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 ' );

À partir de l'objet $client , vous avez accès à tous les points de terminaison de l'API GitHub disponibles.

Utilisation du cache

Cet exemple utilise l'adaptateur Redis du pool de cache PSR6. Voir http://www.php-cache.com/ pour des alternatives.

 <?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 ();

En utilisant le cache, le client obtiendra des réponses en cache si les ressources n'ont pas changé depuis la dernière fois, sans atteindre la X-Rate-Limit imposée par github.

Documentation

Voir le répertoire doc pour une documentation plus détaillée.

Licence

php-github-api est sous licence MIT - voir le fichier LICENSE pour plus de détails

Mainteneurs

Veuillez d'abord lire cet article.

Cette bibliothèque est maintenue par les personnes suivantes (triées par ordre alphabétique) :

• @acrobate
• @Nyholm

Contributeurs

• Merci à Thibault Duplessis alias. ornicar pour sa première version de cette bibliothèque.
• Merci à Joseph Bielawski alias. Stloyd pour sa contribution et son soutien.
• Merci à noloh pour sa contribution sur l'API Objet.
• Merci à bshaffer pour sa contribution sur l'API Repo.
• Merci à Rolf van de Krol pour ses innombrables contributions.
• Merci à Nicolas Pastorino pour sa contribution sur l'API Pull Request.
• Merci à Edoardo Rivello pour sa contribution sur l'API Gists.
• Merci à Miguel Piedrafita pour sa contribution à l'API v4 & Apps.
• Merci à Emre DEGER pour sa contribution à l'API Actions.

Merci à GitHub pour l'API et la documentation de haute qualité.