GraphQL API

Bagisto's GraphQL API delivers a modern, flexible approach to e-commerce data access. Built on Laravel Lighthouse, it provides efficient querying capabilities perfect for headless commerce, mobile apps, and modern frontend frameworks.

🚀 Quick Start

Live Demo

Experience the power of GraphQL with our interactive demo:

🌐 GraphQL API Demo - Test queries and explore the schema in real-time

Interactive Playground

The demo includes GraphiQL playground where you can write queries, explore documentation, and see real-time results.

📦 Installation

Step 1: Install the Package

Install the GraphQL API package via Composer:

composer require bagisto/graphql-api

Step 2: Configure Middleware

Update your bootstrap/app.php file to ensure proper session handling:

use Illuminate\Session\Middleware\StartSession;
use Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse;

return Application::configure(basePath: dirname(__DIR__))
   ->withMiddleware(function (Middleware $middleware) {
      // ... rest of middleware setup

      /**
       * Remove session and cookie middleware from the 'web' middleware group.
       */
      $middleware->removeFromGroup('web', [StartSession::class, AddQueuedCookiesToResponse::class]);

      /**
       * Adding session and cookie middleware globally to apply across non-web routes (e.g. GraphQL)
       */
      $middleware->append([StartSession::class, AddQueuedCookiesToResponse::class]);
   })
   // ... rest of configuration

Important Configuration

This middleware configuration ensures sessions work properly with GraphQL endpoints, which is essential for authentication and cart management.

Step 3: Environment Configuration

Add the following JWT settings to your .env file:

# JWT Configuration for GraphQL API
JWT_TTL=525600
JWT_SHOW_BLACKLIST_EXCEPTION=true

# API Key for mobile/frontend authentication
MOBIKUL_API_KEY=your-secure-api-key-here

Security Best Practice

Generate a strong, unique API key for production environments. This key should be kept secure and only shared with your development team.

Step 4: Install and Publish Assets

Run the installation command to set up configurations:

php artisan bagisto-graphql:install

This command will:

• Publish GraphQL schema files
• Set up authentication routes
• Configure GraphiQL playground

🔧 Testing Your Setup

GraphiQL Playground

Access the interactive GraphQL playground:

http://your-domain.com/graphiql

Direct API Endpoint

For programmatic access or tools like Postman:

http://your-domain.com/graphql

🔗 Next Steps

Ready to build with GraphQL? Here are your next steps:

• 🎮 Try the Live Demo

Need Traditional REST?

If you prefer traditional REST endpoints, check out our REST API documentation.