Code Monkey home page Code Monkey logo

github-api's Introduction

GitHub API

A PHP GitHub API wrapper wich used the Laravel HTTP Client (based on Guzzle HTTP client).

This package does not require Laravel and can be used in any PHP application.

The API endpoint methods are automatically generated with the references from octokit/openapi.

Installation

composer require norman-huth/github-api

Usage

<?php

use NormanHuth\GithubApi\Client;

require_once __DIR__ . '/vendor/autoload.php';

$client = new Client('{GITHUB_TOKEN_HERE}');

$response = $client->repos()->reposCreateAFork(
    owner: 'Muetze42',
    repo: 'github-api',
    requestBody: ['organization' => 'MyVendor', 'name' => 'MyRepo']
);

// Get data as array
return $response->json()
// Get data as object
return $response->object()
// More infos: https://laravel.com/docs/http-client#making-requests

Every method returns a \Illuminate\Http\Client\Response.

<?php

if ($response->successful()) {
    return $response->json();
}

Endpoints

See ENDPOINTS.md

Aliases methods for the current authenticated user

For frequently used endpoints for the current authenticated user, there are also additional methods that can be called directly from the client.

Get the authenticated user

Alias for $client->users()->getTheAuthenticatedUser().

Use the REST API to get public and private information about authenticated users.

Reference: https://docs.github.com/en/rest/users/users#get-the-authenticated-user

<?php

$client->whoami();

List repositories for the authenticated user

Reference: https://docs.github.com/en/rest/repos/repos#list-repositories-for-the-authenticated-user

Alias for $client->repos()->listRepositoriesForTheAuthenticatedUser().

<?php

$client->userRepositories();

List gists for the authenticated user

Reference: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user

Alias for $client->gists()->listGistsForTheAuthenticatedUser().

<?php

$client->userGists();

List issues assigned to the authenticated user

Reference: https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user

Alias for $client->issues()->listIssuesAssignedToTheAuthenticatedUser().

<?php

$client->userIssues();

List notifications for the authenticated user

Reference: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user

Alias for $client->activity()->listNotificationsForTheAuthenticatedUser().

<?php

$client->userNotifications();

List organization issues assigned to the authenticated user

Reference: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user

Alias for $client->issues()->listOrganizationIssuesAssignedToTheAuthenticatedUser().

<?php

$client->userOrganizationIssues();

List repository notifications for the authenticated user

Reference: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user

Alias for $client->activity()->listRepositoryNotificationsForTheAuthenticatedUser().

<?php

$client->userRepositoryNotifications();

github-api's People

Contributors

muetze42 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.