https://github.com/ruslantolstov/rswag-example

Demo how to use rswag-api, rswag-specs.
https://github.com/ruslantolstov/rswag-example

api rswag rswag-api rswag-specs ruby swagger

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ruslantolstov/rswag-example
• Owner: ruslantolstov
• Created: 2019-06-29T09:57:05.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T20:12:17.000Z (almost 2 years ago)
• Last Synced: 2023-04-04T23:56:37.377Z (over 1 year ago)
• Topics: api, rswag, rswag-api, rswag-specs, ruby, swagger
• Language: Ruby
• Homepage:
• Size: 97.7 KB
• Stars: 21
• Watchers: 0
• Forks: 3
• Open Issues: 22
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

```