Сybersquatting the name for a brest ( better REST ) gem.
Install the gem and add to the application's Gemfile by executing:
$ bundle add brest
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install brest
TODO: Write usage instructions here
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 the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/brest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
- Major improvements
- Allow nested selections in included model.
- Multiple schemas aka versions
- Multiple ORM adapters.
- Separate ActiveRecord adapter from preparation stuff
- Introduce sequel adapter
- Move activerecord to dev_dependencies and add check on any of supported ORMs presence
- DSL improvements
- Full DSL description with a example models relations
- ActiveStorage helpers for preloading
- Replace '$ref' => :Model, with type: :Model
- Better api definitions helpers ( in body params + allowing schema to be mentioned in parameter function, right now its a pretty messed up with the blank names params e.t.c. )
- Test coverage improvements (Cover with test all extensions related to synthetic attributes, jsonb models e.t.c.)
- Rethink data structures and relations
- nested attributes models
- jsonb
- includes_sw
- injectable attributes
- select_sw
- select_sw nested
- synthetic attributes
- property extended definition without '$ref'
- Examine schema with validators and ensure no swagger-ui hacks are used anymore, swagger UI is a messed up outdated thingy, use Postman instead.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Brest project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.