php github api

API GitHub PHP

Pembungkus Berorientasi Objek sederhana untuk GitHub API, ditulis dengan PHP.

Menggunakan GitHub API v3 & mendukung GitHub API v4. Objek API (v3) sangat mirip dengan RESTful API.

Fitur

• Ringan dan cepat berkat pemuatan kelas API yang lambat
• Diuji dan didokumentasikan secara ekstensif

Persyaratan

• PHP >= 7.2
• Implementasi PSR-17
• Implementasi PSR-18

Instal cepat

Melalui Komposer.

Perintah ini akan membantu Anda memulai dan menjalankan klien HTTP Guzzle dengan cepat.

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

Instalasi tingkat lanjut

Kami dipisahkan dari klien perpesanan HTTP mana pun dengan bantuan HTTPlug.

Menggunakan klien http yang berbeda

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

Untuk menyiapkan klien Github dengan klien HTTP ini

 use Github  Client ;
use Symfony  Component  HttpClient  HttplugClient ;

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

Baca selengkapnya tentang menggunakan klien yang berbeda di dokumen kami.

Integrasi kerangka kerja

Laravel

Untuk mengintegrasikan perpustakaan ini di laravel Graham Campbell membuat graham-campbell/github. Lihat petunjuk instalasi untuk memulai di laravel.

Penggunaan dasar klien 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 ' );

Dari objek $client , Anda memiliki akses ke semua titik akhir api GitHub yang tersedia.

Penggunaan cache

Contoh ini menggunakan adaptor redis kumpulan cache PSR6. Lihat http://www.php-cache.com/ untuk alternatif.

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

Dengan menggunakan cache, klien akan mendapatkan respons yang di-cache jika sumber daya tidak berubah sejak terakhir kali, tanpa mencapai X-Rate-Limit yang diberlakukan oleh github.

Dokumentasi

Lihat direktori doc untuk dokumentasi lebih detail.

Lisensi

php-github-api dilisensikan di bawah Lisensi MIT - lihat file LISENSI untuk detailnya

Pemelihara

Silakan baca postingan ini terlebih dahulu.

Perpustakaan ini dikelola oleh orang-orang berikut (diurutkan berdasarkan abjad):

• @akrobat
• @Nyholm

Kontributor

• Terima kasih kepada Thibault Duplessis alias. ornicar untuk versi pertamanya dari perpustakaan ini.
• Terima kasih kepada Joseph Bielawski alias. sloyd atas kontribusi dan dukungannya.
• Terima kasih kepada noloh atas kontribusinya pada Object API.
• Terima kasih kepada bshaffer atas kontribusinya pada Repo API.
• Terima kasih kepada Rolf van de Krol atas kontribusinya yang tak terhitung jumlahnya.
• Terima kasih kepada Nicolas Pastorino atas kontribusinya pada Pull Request API.
• Terima kasih kepada Edoardo Rivello atas kontribusinya pada Gists API.
• Terima kasih kepada Miguel Piedrafita atas kontribusinya pada v4 & Apps API.
• Terima kasih kepada Emre DEGER atas kontribusinya pada Actions API.

Terima kasih kepada GitHub untuk API dan dokumentasi berkualitas tinggi.