creates swagger blocks files based on the JSONAPI::Resource file http://jsonapi-resources.com/
Add this line to your application's Gemfile:
gem 'jsonapi-swagger-blocks-generator'And then execute:
$ bundle
Or install it yourself as:
$ gem install jsonapi-swagger-blocks-generator
$ rails g jsonapi:swagger_blocks User
or specifying the namespace of the resources folder
$ rails g jsonapi:swagger_blocks User Api::V1
We are following the Gitflow workflow. The active development branch is dev, the stable branch is master.
Contributions will be accepted to the dev only.
-
If it is a major feature, please create an Issue and discuss with the project leaders.
-
If in step 1 you get an acknowledge from the project leaders, use the following procedure to submit a patch:
a. Fork Fast JSONAPI Swagger blocks generator on github ( http://help.github.com/fork-a-repo/ )
b. Create a topic branch (git checkout -b my_branch)
c. Push to your branch (git push origin my_branch)
d. Initiate a pull request on github ( http://help.github.com/send-pull-requests/ )
e. Done :)
-
Run the tests. We only take pull requests with passing tests.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the SwaggerBlocksGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.