vite-plugin-graphiql

Vite + GraphqiQL

Integrate GraphiQL IDE in your Vite projects

Please note that this plugin is only intended to be used in development mode.

Getting Started

First, install the plugin:

npm install --save-dev vite-plugin-graphiql

yarn add --dev vite-plugin-graphiql

pnpm add --save-dev vite-plugin-graphiql

GraphiQL requires graphql to be installed in your project; so install that too if you haven't already.

Then, import and add the plugin to your vite.config.ts and pass in the required configuration options:

import { defineConfig } from 'vite'
import graphiql from 'vite-plugin-graphiql'

export default defineConfig({
  plugins: [
    graphiql({
      client: {
        url: 'https://mygraphqlapi.com/graphql',
      },
    }),
  ],
})

Now start your dev server and navigate to http://localhost:5173/__graphiql to see the GraphiQL IDE.

Configuration

You can find the full configuration options here.

Acknowledgments

Inspired by @unocss/inspector

License

Licensed under the MIT License.

Changelog

1.1.0 (2022-12-17)

Features

• add support for @graphiql/plugin-explorer (#18) (eabdf8f)

Bug Fixes

• move bundled client deps to devDependencies (#15) (6b7f416)