Giter Club home page Giter Club logo

graphql_schema's Introduction

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:

gem 'graphql_schema'

And then execute:

$ bundle

Or install it yourself as:

$ gem install graphql_schema

Usage

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.

Contributing

See our contributing guidelines for more information.

License

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

graphql_schema's People

Contributors

aaackerman avatar cocoahero avatar dylanahsmith avatar eapache avatar jhoffmcd avatar mikkoh avatar swalkinshaw avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

graphql_schema's Issues

Provide a way to get a subset of the schema

When generating code based on a schema instead of a set of queries, a lot more code will be generated than necessary due to unused fields. This can cause simple apps to bloat due to fields being added to the server.

This could be solved by having a way to get a subset of the schema to use as an input to a code generator.

One way to specify the subset could be as a hash with type names as keys and an array of fields as values. E.g.

---
QueryRoot:
- node
- shop

The type from the fields and arguments could be used to infer the needed types automatically. Alternatively, we could require the optional arguments to be explicitly provided to avoid extra code generation from unused arguments or their input types.

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.