ShittyQl
ShittyQl simple gem for building constructive JSON API using GET requests.
It’s more a pragmatic tool and philosophy of how to write JSON API where Frontend constructs what data it needs using GET query
So the gem tries to do what GraphQL for obtaining data but obviously gem is more :hankey:
Example /accounts?include=account.name,account.books.page.2,account.books.limit.10
todo: gem is ready I’m just writing up documentation, pls come back soon
Installation
Add this line to your application’s Gemfile:
“by gem ‘shitty_ql’
“
And then execute:
$ bundle
Or install it yourself as:
$ gem install shitty_ql
Usage
todo: Usage in progress
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
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
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shitty_ql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the ShittyQl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.