ditkrg/jsonapi-swagger
4
0
Fork 0
mirror of https://github.com/ditkrg/jsonapi-swagger.git synced 2026-01-22 13:56:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Create a JSONAPI Swagger.
27 Commits 1 Branch 12 Tags 82 KiB
HTML 74.8%
Ruby 24.9%
Shell 0.3%
a5fe2f7fdc
Go to file
YingRui Lu a5fe2f7fdc bump version 0.6.0
2019-06-19 14:11:56 +08:00
bin init 2019-04-18 10:54:27 +08:00
lib bump version 0.6.0 2019-06-19 14:11:56 +08:00
.gitignore init 2019-04-18 10:54:27 +08:00
Gemfile init 2019-04-18 10:54:27 +08:00
jsonapi-swagger.gemspec support generate swagger.json without rswag 2019-06-19 14:06:56 +08:00
LICENSE update README.md 2019-05-01 14:28:25 +08:00
Rakefile init 2019-04-18 10:54:27 +08:00
README.md update README.md 2019-05-14 14:09:49 +08:00

README.md

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

rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource

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.