Generate JSONAPI Swagger Doc.
Add this line to your application's Gemfile:
gem 'jsonapi-swagger'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jsonapi-swagger
- 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' end
- generate swagger.json
# gen swagger/v1/swagger.json bundle exec rails generate jsonapi:swagger User # UserResource < JSONAPI::Resource
- additional
use rswag, have to run
# gen swagger/v1/swagger.json bundle exec rails rswag:specs:swaggerize
- immutable resources
- filter/sort resources
- mutable resources
- generate swagger.json without rswag
Bug reports and pull requests are welcome on GitHub at https://github.com/superiorlu/jsonapi-swagger.