Giter Club home page Giter Club logo

graphiql-plus's Introduction

GraphiQL Plus

The most โœ”๏ธ fully-featured, ๐Ÿ”‹ batteries-included, โšก supercharged, GraphiQL IDE for ๐Ÿงฉ querying any GraphQL endpoint ๐Ÿ”ฅ.

This package extends the default GraphiQL IDE with the most useful features. This repo is the source for building a static html/js standalone web GraphiQL instance.

Note: accessible at http://localhost:8245/ after running npm run serve

You can use this right away at https://unpkg.com/graphiql-static/index.html.

Features

  • ๐Ÿ”GraphiQL Explorer - an interactive explorer plugin to visually create and interact with the GraphQL schema
  • ๐Ÿ“œGraphiql Code Exporter - a codegen tool to take your GraphQL queries and plug them into your app
  • ๐Ÿ—„๏ธ Persists your queries and headers into browser's local storage whenever you close the window. This data is keyed by endpoint so you don't mix up queries for different endpoints. Also saves your layout preferences regardless of endpoint. Remembers the last endpoint you used if none provided in headers.
  • โœˆ๏ธ Offline support - for when you need to work on your excellent GraphQL app on a plane, train, or elsewhere off the grid
  • (coming soon) ๐Ÿ‘ฎ Authentication helpers for AWS AppSync APIs
  • All the expected features you know and love from GraphiQL

How to use

Build this app with npm build and host it on your favorite static hosting service.

Pass in the following URL parameters at the end of your URL (after ?, before #) to provide inputs to the GraphiQL IDE.

  • endpoint: Sets the endpoint to send GraphQL queries to. Default: hostname
  • headers: Sets headers to include in requests to the GraphQL endpoint as URL-Encoded JSON. Default (always included): { "Content-Type": "application/json" }
  • query: Sets the default query to include in the Query pane. Default: The GraphiQL default
  • variables: Sets the default query to include in the Variables pane. Default: none
  • operationName: Sets the default operation to execute and display in the Output pane. Default: none

The values of these parameters will be persisted to browser localStorage whenever the window is closed. Including these parameters in the request to load the page will ignore the localStorage values. The page URL will be continuously updated with these parameters so you can easily share the IDE state.

License

MIT

graphiql-plus's People

Contributors

aaronharris avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.