🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

graphql-playground

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

graphql-playground

0.1.5
Version published
Maintainers
1
Created

GraphQL Playground

Mount the GraphQL Playground in Ruby on Rails.

Installation

Add this line to your application's Gemfile:

gem 'graphql-playground'

And then execute:

$ bundle

Or install it yourself as:

$ gem install graphql-playground

Usage

Mount the Engine

Add the engine to routes.rb:

# config/routes.rb
Rails.application.routes.draw do
  # ...
  if Rails.env.development?
    mount GraphQL::Playground::Engine, at: "/graphql-playground", graphql_path: "/graphql"
  end
end
  • at: is the path where GraphQL Playground will be served. You can access GraphQL Playground by visiting that path in your app.
  • graphql_path: is the path to the GraphQL endpoint. GraphQL Playground will send queries to this path.

If you're using Rails 5 in "API mode", you'll also need to add require "sprockets/railtie" to your application.rb.

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

FAQs

Package last updated on 02 Jul 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts