https://github.com/penx/graphiql-middleware

Middleware for serving GraphiQL e.g. with Express
https://github.com/penx/graphiql-middleware

Last synced: 11 months ago
JSON representation

Middleware for serving GraphiQL e.g. with Express

• Host: GitHub
• URL: https://github.com/penx/graphiql-middleware
• Owner: penx
• Created: 2020-09-04T15:14:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-04T17:30:09.000Z (over 5 years ago)
• Last Synced: 2025-02-13T06:40:36.491Z (11 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/graphiql-middleware
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GraphiQL Middleware

Middleware for serving GraphiQL.

Works with Express and any other server that supports middleware of the format `(_, {set, send}) => ()`

## API

```js

graphiqlMiddleware(options, props)

```

Where `options` are:

- endpointURL

And `props` are serializable [GraphiQL component props](https://github.com/graphql/graphiql/master/packages/graphiql/README.md#props).

## Usage

```js

import { graphiqlMiddleware } from 'graphiql-middleware';

app.use(

    '/graphiql',

    graphiqlMiddleware({

        endpointURL: '/graphql',

    }, {

        headerEditorEnabled: true,

        shouldPersistHeaders: true

    })),

);

```