Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmosolgo/graphiql-rails
Mount the GraphiQL query editor in a Rails app
https://github.com/rmosolgo/graphiql-rails
Last synced: about 20 hours ago
JSON representation
Mount the GraphiQL query editor in a Rails app
- Host: GitHub
- URL: https://github.com/rmosolgo/graphiql-rails
- Owner: rmosolgo
- License: mit
- Created: 2016-01-05T02:54:57.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T19:03:31.000Z (4 months ago)
- Last Synced: 2024-12-03T09:03:30.208Z (9 days ago)
- Language: JavaScript
- Homepage:
- Size: 5.64 MB
- Stars: 447
- Watchers: 14
- Forks: 137
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - graphiql-rails
README
# GraphiQL-Rails [](https://badge.fury.io/rb/graphiql-rails) [](https://github.com/rmosolgo/graphiql-rails/actions/workflows/test.yml)
Mount the [GraphiQL IDE](https://github.com/graphql/graphiql) in Ruby on Rails.
## Installation
Add to your Gemfile:
```ruby
bundle add graphiql-rails
```
Additionally, you'll need [Sprockets or Propshaft](#sprockets-or-propshaft) to serve the JS and CSS assets.
## Usage
### Mount the Engine
Add the engine to `routes.rb`:
```ruby
# config/routes.rb
Rails.application.routes.draw do
# ...
if Rails.env.development?
mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/your/endpoint"
end
end
```
- `at:` is the path where GraphiQL will be served. You can access GraphiQL by visiting that path in your app.
- `graphql_path:` is the path to the GraphQL endpoint. GraphiQL will send queries to this path.
### Sprockets or Propshaft
You'll need [Sprockets](https://github.com/rails/sprockets) or [Propshaft](https://github.com/rails/propshaft) to deliver the JS and CSS for GraphiQL. If you don't already have one of those, you can add them with:
```sh
$ bundle add sprockets-rails
# or
$ bundle add propshaft
```
#### API Mode
If you're using Rails 6+ in "API mode", you'll also need to do the following:
1. Add `require "sprockets/railtie"` to your `application.rb`.
2. Create an `app/assets/config/manifest.js` file and add the following:
```
//= link graphiql/rails/application.css
//= link graphiql/rails/application.js
```
### Configuration
You can override `GraphiQL::Rails.config` values in an initializer (eg, `config/initializers/graphiql.rb`). The configs are:
- `query_params` (boolean, default `false`): if `true`, the GraphQL query string will be persisted the page's query params
- `initial_query` (string, default `nil`): if provided, it will be rendered in the query pane for a visitor's first visit
- `title` (string, default `nil`): if provided, it will be rendered in the page tag
- `logo` (string, default `nil`): if provided, it will be the text logo
- `csrf` (boolean, default `true`): include `X-CSRF-Token` in GraphiQL's HTTP requests
- `header_editor_enabled` (boolean, default `false`): if provided, the header editor will be rendered
- `headers` (hash, `String => Proc`): procs to fetch header values for GraphiQL's HTTP requests, in the form `(view_context) -> { ... }`. For example:
```ruby
GraphiQL::Rails.config.headers['Authorization'] = -> (context) { "bearer #{context.cookies['_graphql_token']}" }
```
- `input_value_deprecation` (boolean, default `false`): if provided, the deprecated arguments will be rendered
### Development
- Tests: `rake test`
- Update GraphiQL & dependencies: `rake update_graphiql`