Skip to content

scottyantipa/jsonapi-swagger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSONAPI Swagger

Generate JSONAPI Swagger Doc.

Gem Version GitHub license

jsonapi-swagger-4-2-9.gif

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'
end
  1. generate swagger.json
# gen swagger/v1/swagger.json
bundle exec rails generate jsonapi:swagger User # UserResource < JSONAPI::Resource
  1. 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

Contributing

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

About

Create a JSONAPI Swagger.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 72.8%
  • Ruby 26.9%
  • Shell 0.3%