JSONAPI Swagger

Generate JSONAPI Swagger Doc.

Installation

Add this line to your application's Gemfile:

gem 'jsonapi-swagger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jsonapi-swagger

Usage

1. config jsonapi swagger

# config/initializers/swagger.rb
Jsonapi::Swagger.config do |config|
  config.use_rswag = false
  config.version = '2.0'
  config.info = { title: 'API V1', version: 'V1'}
  config.file_path = 'v1/swagger.json'
  # underscored, camelized, dasherized, or custom
  config.attribute_format = 'dasherized'
end

2. generate swagger.json

# gen swagger/v1/swagger.json
bundle exec rails generate jsonapi:swagger User # UserResource < JSONAPI::Resource

3. additional

use rswag, have to run

# gen swagger/v1/swagger.json
 bundle exec rails rswag:specs:swaggerize

RoadMap

• immutable resources
• filter/sort resources
• mutable resources
• generate swagger.json without rswag

Resource

• JSONAPI
• JSONAPI::Resources
• Rswag

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/superiorlu/jsonapi-swagger.