Swalidate
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/swalidate
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'swalidate'
And then execute:
$ bundle
Or install it yourself as:
$ gem install swalidate
Usage
swalidate_config = {
file_path: 'path.yaml', # swagger config file. example of app root
subdomain: 'api', # validation applies only to this subdomain
path_prefix: '/v1' # validation applies only to the paths starting with path_prefix
}
config.middleware.insert_after ActionDispatch::ParamsParser, Swalidate::Middleware, swalidate_config
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/furkanayhan/swalidate.
License
The gem is available as open source under the terms of the MIT License.