Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxcoto/graphoid
Instant GraphQL REST-API for Rails from ActiveRecord or Mongoid models https://maxcoto.github.io/graphoid/
https://github.com/maxcoto/graphoid
activerecord graphiql graphoid graphql graphql-api graphql-rails graphql-ruby mongoid rails rest rest-api ruby
Last synced: 3 months ago
JSON representation
Instant GraphQL REST-API for Rails from ActiveRecord or Mongoid models https://maxcoto.github.io/graphoid/
- Host: GitHub
- URL: https://github.com/maxcoto/graphoid
- Owner: maxcoto
- License: mit
- Created: 2019-04-11T01:02:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T15:30:55.000Z (almost 2 years ago)
- Last Synced: 2024-10-08T22:05:01.440Z (3 months ago)
- Topics: activerecord, graphiql, graphoid, graphql, graphql-api, graphql-rails, graphql-ruby, mongoid, rails, rest, rest-api, ruby
- Language: Ruby
- Homepage:
- Size: 9.82 MB
- Stars: 36
- Watchers: 3
- Forks: 8
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/maxiperezc/graphoid)
[](https://rubygems.org/gems/graphoid)
[](https://codeclimate.com/github/maxiperezc/graphoid/maintainability)
[](https://codeclimate.com/github/maxiperezc/graphoid/test_coverage)
Generates a full GraphQL API using introspection of Mongoid or ActiveRecord models.
## API Dodocumentation
The [API Documentation](https://maxcoto.github.io/graphoid/) that displays how to use the queries and mutations that Graphoid automatically generates.
## Dependency
This gem depends on [the GraphQL gem](https://github.com/rmosolgo/graphql-ruby).
Please install that gem first before continuing
## Installation
Add this line to your Gemfile:
```ruby
gem 'graphoid'
```
```bash
$ bundle install
```
## Database
Create the file `config/initializers/graphoid.rb`
And configure the database you want to use in it (:mongoid or :active_record)
```ruby
Graphoid.configure do |config|
config.driver = :mongoid
end
```
## Usage
You can determine which models will be visible in the API by including the Graphoid Queries and Mutations concerns
```ruby
class Person
include Graphoid::Queries
include Graphoid::Mutations
end
```
## Examples
You can find an example that uses ActiveRecord in the [Tester AR folder](https://github.com/maxiperezc/graphoid/tree/master/spec/tester_ar)
And an example with Mongoid in the [Tester Mongo folder](https://github.com/maxiperezc/graphoid/tree/master/spec/tester_mongo)
In this same repository.
## Contributing
- Live Reload
- Aggregations
- Permissions on fields
- Relation with aliases tests
- Write division for "every" in Mongoid and AR
- Sort top level models by association values
- Filter by Array or Hash.
- has_one_through implementation
- has_many_selves tests
- has_and_belongs_to_many_selves tests
- Embedded::Many filtering implementation
- Embedded::One filtering with OR/AND
## Testing
```bash
$ DRIVER=ar DEBUG=true bundle exec rspec
$ DRIVER=mongo DEBUG=true bundle exec rspec
```
## Thank You !!
[Ryan Yeske](https://github.com/rcy) for the whole idea and for validating that metaprogramming this was possible.
[Andres Rafael](https://github.com/aandresrafael) for working so hard on connecting the gem on the frontend and finding its failures.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).