bagisto/graphql-api

Bagisto GraphQL API

v2.0.1 2024-03-21 06:14 UTC

Requires

• mll-lab/laravel-graphiql: ^3.1
• nuwave/lighthouse: ^6.23
• php-open-source-saver/jwt-auth: ^2.1

MIT

• Anmol Singh Chauhan

README

Laravel eCommerce headless APIs allow you to experience seamless and easily scalable storefront performance. The open-source headless laravel platform built on GraphQL based Rest API delivers ultra-fast, dynamic, and personalized shopping experiences.

Read our documentation: Bagisto GraphQL API Docs

The Bagisto GraphQL API is made in collaboration with Ucraft Team

1. Requirements:

• Bagisto: v2.0.0

2. Installation:

To clone Bagisto GraphQL run the below command from terminal:

composer require bagisto/graphql-api dev-main

• Add the below-line inside the modules index in config/concord.php file:

\Webkul\GraphQLAPI\Providers\ModuleServiceProvider::class,

• Find a file app/Http/Kernel.php from root and add these two middlewares inside the $middleware array:

\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,

• Find a file config/auth.php from root and bellow code inside guard:

    'api' => [
            'driver'   => 'jwt',
            'provider' => 'customer',
        ],

   'admin-api' => [
            'driver'   => 'jwt',
            'provider' => 'admin',
        ],

• Find a file config/auth.php from root and bellow code inside providers:

    'customer' => [
            'driver' => 'eloquent',
            'model'  => Webkul\GraphQLAPI\Models\Customer\Customer::class,
        ],

    'admin' => [
            'driver' => 'eloquent',
            'model'  =>  Webkul\GraphQLAPI\Models\Admin\Admin::class,
        ],

• Add the JWT_TTL (JWT time to live) & JWT_SHOW_BLACKLIST_EXCEPTION entries in the .env file:

JWT_TTL=525600
JWT_SHOW_BLACKLIST_EXCEPTION=true

To install and publish the assests and configurations, run below command from the root in terminal:

php artisan bagisto-graphql:install

• Now to use the graphql-playground for testing the APIs:

http://your-domain.com/graphiql

• You can also use the Postman for testing the APIs:

http://your-domain.com/graphql

That's it, now just execute the project on your specified domain.