https://github.com/Shopify/graphql_schema

Classes to access the GraphQL instrospection result rather than using the parsed JSON directly as a hash.
https://github.com/Shopify/graphql_schema

Last synced: 19 days ago
JSON representation

Classes to access the GraphQL instrospection result rather than using the parsed JSON directly as a hash.

• Host: GitHub
• URL: https://github.com/Shopify/graphql_schema
• Owner: Shopify
• License: mit
• Created: 2016-11-21T21:14:53.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T14:28:43.000Z (2 months ago)
• Last Synced: 2024-11-18T01:08:06.083Z (25 days ago)
• Language: Ruby
• Size: 48.8 KB
• Stars: 15
• Watchers: 427
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• stars - graphql_schema
• stars - graphql_schema

README

        
# GraphQL Schema

Classes to more conveniently access the GraphQL instrospection

result rather than using the parsed json directly as a hash.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'graphql_schema'

```

And then execute:

```

bundle

```

Or install it yourself as:

```

gem install graphql_schema

```

## Usage

```ruby

require 'graphql_schema'

require 'json'

introspection_result = JSON.parse(File.read("schema.json"))

schema = GraphQLSchema.new(introspection_result)

schema.types.select(&:object_type?).each do |type|

  type.fields.each do |field|

    puts "#{field.name} -> #{field.type.name}"

  end

end

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

See our [contributing guidelines](CONTRIBUTING.md) for more information.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).