GraphiQL PSR-15 Middleware

Add a GraphiQL interface to your application with this PSR-15 middleware.

This is basically a copy of graphiql-middleware adjusted for PSR-15.

Install

composer require dr-schopalopp/graphiql-middleware

Usage

This middleware was developed in a slim project, but it should work with any other PSR-15 compatible framework.

Slim 4

// app/dependencies.php

use DrSchopalopp\GraphiQLMiddleware\GraphiQLMiddleware;

return function (ContainerBuilder $containerBuilder) {
    $containerBuilder->addDefinitions([
        // ...
        
        GraphiQLMiddleware::class => function () {
            return new GraphiQLMiddleware();
        }
        
        // ...
    ]);
};

// app/middleware.php

use DrSchopalopp\GraphiQLMiddleware\GraphiQLMiddleware;

return function (App $app) {
    // ...
    
    $app->add(GraphiQLMiddleware::class);
    
    // ...
};

// app/routes.php

return static function (App $app) {
    // ...

    // dummy route necessary otherwise you will get an HTTP 405 Method Not Allowed error 
    $app->get('/graphiql', function (Request $request, Response $response) {
        return $response;
    });
    
    // ...
};

see HTTP 405 Method Not Allowed for details

License

The MIT License (MIT). Please see License File for more information.

graphiql-middleware's People

Contributors

Watchers

graphiql-middleware's Issues

Catch HTTP 405 Method not allowed Error

HTTP 405 Method not allowed Error should be catched in GraphiQLMiddleware::process and delivery GraphiQL index.html instead. After this the dummy route isn't necessary anymore

Recommend Projects