No commit activity in last 3 years
No release in over 3 years
The swagger-bloks files are created based on the JSONAPI::Resources files. To use this gem, you need to have jsonapi-resources gem installed.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0
 Project Readme

JSONAPI Swagger Blocks Generator

Gem Version Maintainability Build Status

creates swagger blocks files based on the JSONAPI::Resource file http://jsonapi-resources.com/

Installation

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

Usage

$ rails g jsonapi:swagger_blocks User

or specifying the namespace of the resources folder

$ rails g jsonapi:swagger_blocks User Api::V1 

Contributing

Contributing to JSONAPI Swagger blocks generator

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.

How to provide a patch for a new feature

  1. If it is a major feature, please create an Issue and discuss with the project leaders.

  2. 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 :)

  3. Run the tests. We only take pull requests with passing tests.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the SwaggerBlocksGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.