shipper/graphql-client

Graphql Client for Laravel

dev-main 2024-06-24 23:08 UTC

ISC

• laravel
• graphql
• Shipper
• Graphql Client

README

Minimal GraphQL client for Laravel.

Requirements

• Composer 2+

Installation

Install Package (Composer 2+)

composer require shipper/graphql-client

Usage

Enviroment variable

GRAPHQL_ENDPOINT="https://api.spacex.land/graphql/"

Authentication

We provide a minimal authentication integration by appending the Authorization header to the request client. You can pass the credentials using an env variable.

GRAPHQL_CREDENTIALS="YOUR_CREDENTIALS"

You can also pass auth credentials at runtime using withToken($credentials) method.

'Authorization' header and 'Bearer' Schema are used by default. You can override the default behaviour by defining following variables in your .env file.

GRAPHQL_AUTHENTICATION_HEADER="Authorization"

// Allowed: basic, bearer, custom
GRAPHQL_AUTHENTICATION="bearer"

Usage/Examples

Import GraphQL Client Facades

use Shipper\GraphqlClient\Facades\GraphQL;

Basic use

return GraphQL::query('
    capsules {
        id
        original_launch
        status
        missions {
            name
            flight
        }
    }
')->get();
//->get('json'); //get response as json object

Mutator Request

return GraphQL::mutator('
    insert_user(name: "David") {
        id
        name
        date_added
    }
')->get();
//->get('json');

You can access "query" or "mutator" as a shortcut if you are not passing variables, if is not the case you must use the "raw" attribute:

return GraphQL::raw('
    mutation($name: String) {
        insert_user(name: $name) {
            id
            name
            date_added
        }
    }
')
->with(["name" => "David"])
->get();
//->get('json');

The variables or payload to the GraphQL request can also be passed using magic methods like:

return GraphQL::raw('
    mutation($name: String) {
        insert_user(name: $name) {
            id
            name
            date_added
        }
    }
')
->withName("David")
->get();
//->get('json');

Raw Response

You can get the raw response from the GraphQL request by using getRaw() method instead of get() in the request.

return GraphQL::raw('
    mutation($name: String) {
        insert_user(name: $name) {
            id
            name
            date_added
        }
    }
')
->with(["name" => "David"])
->getRaw();
//->getRaw('json');

If you want to address the request to another endpoint, you can do :

return GraphQL::endpoint("https://api.spacex.land/graphql/")
->query('
    capsules {
        id
        original_launch
        status
        missions {
            name
            flight
        }
    }
')->get();
//->get('json');

Headers

You can include a header to the request by using the attribute "header" or add multiple headers by "withHeaders":

return GraphQL::query($query)
->header('name', 'value')
->withHeaders([
    'name' => 'value',
    'name' => 'value'
])->get();

Context

Add additional context to the request

return GraphQL::query($query)
->context([
    'ssl' => [
         "verify_peer" => false,
         "verify_peer_name" => false,
    ]
  ])->get();

Author

• David Gutierrez @bendeckdavid

Top Contributors ⭐

• Ehsan Quddusi @ehsanquddusi

Contributors

• Ryan Mayberry @kerkness
• Jamie Duong @chiendv