forked from loafle/openapi-generator-original
26e70fe642
* Rename templateDir: rails5 -> ruby-on-rails-server * Rename script: rails5-petstore-server.sh -> ruby-on-rails-server-petstore.sh * Rename sample folder: rails5 -> ruby-on-rails * Rename script(openapi3): rails5-petstore-server.sh -> ruby-on-rails-server-petstore.sh * Update ruby-on-rails-server-petstore.sh * Rename templateDir: sinatra -> ruby-sinatra-server * Rename script: sinatra-petstore-server.sh -> ruby-sinatra-server-petstore.sh * Rename sample folder: sinatra -> ruby-sinatra * Update script * Rename templateDir: ruby -> ruby-client * Rename script: ruby-petstore.sh -> ruby-client-petstore.sh * Update scripts * Update samples - bin/ruby-sinatra-server-petstore.sh - bin/ruby-on-rails-server-petstore.sh - bin/ruby-client-petstore.sh - bin/security/ruby-client-petstore.sh
26 lines
455 B
Markdown
26 lines
455 B
Markdown
# OpenAPI for Rails 5
|
|
|
|
This is a project to provide OpenAPI support inside the [Ruby on Rails](http://rubyonrails.org/) framework.
|
|
|
|
## Prerequisites
|
|
You need to install ruby >= 2.2.2 and run:
|
|
|
|
```
|
|
bundle install
|
|
```
|
|
|
|
## Getting started
|
|
|
|
This sample was generated with [openapi-generator](https://github.com/openapitools/openapi-generator) project.
|
|
|
|
```
|
|
bin/rake db:create db:migrate
|
|
bin/rails s
|
|
```
|
|
|
|
To list all your routes, use:
|
|
|
|
```
|
|
bin/rake routes
|
|
```
|