All Projects → ruslantolstov → rswag-example

ruslantolstov / rswag-example

Licence: other
Demo how to use rswag-api, rswag-specs.

Programming Languages

ruby
36898 projects - #4 most used programming language

Projects that are alternatives of or similar to rswag-example

jsonapi-swagger
Create a JSONAPI Swagger.
Stars: ✭ 49 (+145%)
Mutual labels:  rswag

README

Demo how to use rswag-api, rswag-specs.

Setup

cp .env.example .env
rails db:create db:migrate
rails server

Setup Docker

docker-compose build
docker-compose up
docker-compose run web rake db:create db:migrate
open http://localhost:3000/

Use docker attach ID to get into the running container, for detach without exit Ctrl-p, Ctrl-q

Generate the Swagger JSON file

rake rswag:specs:swaggerize
open http://localhost:3000/api/docs/client/swagger.json
open http://localhost:3000/api/docs/backoffice/swagger.json
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].