php github api

PHP GitHub API

Un contenedor simple orientado a objetos para la API de GitHub, escrito con PHP.

Utiliza GitHub API v3 y es compatible con GitHub API v4. La API de objetos (v3) es muy similar a la API RESTful.

Características

• Ligero y rápido gracias a la carga diferida de clases API
• Ampliamente probado y documentado

Requisitos

• PHP >= 7.2
• Una implementación del PSR-17
• Una implementación del PSR-18

Instalación rápida

Vía Compositor.

Este comando lo pondrá en funcionamiento rápidamente con un cliente HTTP Guzzle.

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

Instalación avanzada

Estamos desacoplados de cualquier cliente de mensajería HTTP con la ayuda de HTTPlug.

Usando un cliente http diferente

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

Para configurar el cliente Github con este cliente HTTP

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

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

Lea más sobre el uso de diferentes clientes en nuestros documentos.

Integraciones de marco

Laravel

Para integrar esta biblioteca en laravel, Graham Campbell creó graham-campbell/github. Consulte las instrucciones de instalación para comenzar en laravel.

Uso básico del cliente 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 ' );

Desde el objeto $client , tiene acceso a todos los puntos finales de la API de GitHub disponibles.

Uso de caché

Este ejemplo utiliza el adaptador redis del grupo de caché PSR6. Consulte http://www.php-cache.com/ para conocer alternativas.

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

Al usar el caché, el cliente obtendrá respuestas almacenadas en caché si los recursos no han cambiado desde la última vez, sin alcanzar el X-Rate-Limit impuesto por github.

Documentación

Consulte el directorio doc para obtener documentación más detallada.

Licencia

php-github-api tiene la licencia MIT; consulte el archivo LICENCIA para obtener más detalles

mantenedores

Por favor lea esta publicación primero.

Esta biblioteca es mantenida por las siguientes personas (ordenadas alfabéticamente):

• @acróbata
• @Nyholm

Colaboradores

• Gracias a Thibault Duplessis alias. ornicar por su primera versión de esta biblioteca.
• Gracias a Joseph Bielawski alias. stloyd por sus contribuciones y apoyo.
• Gracias a noloh por su contribución en la API de objetos.
• Gracias a bshaffer por su contribución a la API de Repo.
• Gracias a Rolf van de Krol por sus innumerables contribuciones.
• Gracias a Nicolás Pastorino por su contribución en la API Pull Request.
• Gracias a Edoardo Rivello por su contribución en la API de Gists.
• Gracias a Miguel Piedrafita por su contribución a la v4 y la API de aplicaciones.
• Gracias a Emre DEGER por su contribución a la API de acciones.

Gracias a GitHub por la API y la documentación de alta calidad.