torvick / ruby-restful-api-example-rails-api

RESTful API sample using rails api.

ruby-restful-api-example-rails-api

RESTful API sample using rails api.

Note: To run the application as a docker container head over README-docker.md.

---

Features added to the app:

• api documentation

  • swagger DSL written inside controllers
  • serving swagger-ui whithin the app

• code quality

  • automatic static analisys of code
  • automatic generation of code coverage reports

• database sample data

  • rake task to load data [from factories] into database

pre-requisites:

• ruby (v2.3.1)
• bundler (v1.12.5)

running

1. download the dependencies

$ bundle install --path=vendor

2. run pending migrations

$ bundle exec rails db:migrate

3. populate the database with random data

$ bundle exec rails db:factories:load

4. load swagger-ui

$ git submodule init
$ git submodule update

5. generate the api documentation

$ bundle exec rake swagger:docs

6. start the app

$ bundle exec rails server

And head over to http://localhost:3000/docs to interact with the api.

useful documentation:

• CHANGELOG.md
• CONFIG.md
• CONTRIBUTING.md
• MONITORING.md