Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@keystonejs/app-graphql-playground

keystonejs1.5kMIT5.2.3

KeystoneJS GraphQL Playground App.

readme

GraphQL Playground App

This is the last active development release of this package as Keystone 5 is now in a 6 to 12 month active maintenance phase. For more information please read our Keystone 5 and beyond post.

View changelog

A KeystoneJS App that creates an Apollo GraphQL playground.

Usage

const { Keystone } = require('@keystonejs/keystone');
const { GraphQLApp } = require('@keystonejs/app-graphql');
const { GraphQLPlaygroundApp } = require('@keystonejs/app-graphql-playground');
const { AdminUIApp } = require('@keystonejs/app-admin-ui');

// Ensure that the GraphQLApp and GraphQLAppPlayground are referring to the same endpoint
const apiPath = '/admin/api';

module.exports = {
  keystone: new Keystone(),
  apps: [
    // This should come before the GraphQLApp, as it sets up the dev query middleware
    new GraphQLPlaygroundApp({ apiPath })
    // Disable the default playground on this app
    new GraphQLApp({ apiPath, graphiqlPath: undefined }),
    new AdminUIApp()
  ],
};

Config

Option Type Default Description
apiPath String /admin/api Change the API path
graphiqlPath String /admin/graphiql Change the Apollo GraphQL playground path

changelog

@keystonejs/app-graphql-playground

5.2.3

Patch Changes

  • e24e4dfce Thanks @dcousens! - Fixes express.Router() usage to fix inheriting of express application settings

5.2.2

Patch Changes

5.2.1

Patch Changes

5.2.0

Minor Changes

Patch Changes

5.1.10

Patch Changes

5.1.9

Patch Changes

5.1.8

Patch Changes

5.1.7

Patch Changes

5.1.6

Patch Changes

5.1.5

Patch Changes

5.1.4

Patch Changes

5.1.3

Patch Changes

5.1.2

Patch Changes

5.1.1

Patch Changes

5.1.0

Minor Changes

Patch Changes

5.0.1

Patch Changes

5.0.0

Major Changes

  • 7b4ed362 #1821 Thanks @jesstelford! - Release @keystonejs/* packages (つ^ ◡ ^)つ

    • This is the first release of @keystonejs/* packages (previously @keystone-alpha/*).
    • All packages in the @keystone-alpha namespace are now available in the @keystonejs namespace, starting at version 5.0.0.
    • To upgrade your project you must update any @keystone-alpha/* dependencies in package.json to point to "@keystonejs/*": "^5.0.0" and update any require/import statements in your code.

Patch Changes

@keystone-alpha/app-graphql-playground

1.0.1

Patch Changes

  • 9b532072: Rename Keystone to KeystoneJS in docs where possible in docs

1.0.0

Major Changes

  • c99c7cd2: First iteration of the GraphQLPlaygroundApp.