/rails-code-first

Add OpenAPI powered documentation to your Rails API with RSwag.

Primary LanguageRubyOtherNOASSERTION

Rails Hello OpenAPI

A quick "Hello World" but for generating OpenAPI, using the Ruby on Rails extension RSwag.

This repository was built as sample code for the Bump.sh guide on Generating OpenAPI docs for Ruby on Rails with RSwag.

Usage

Clone the repository down to give it a try.

# Set everything up
$ bundle install

# Export the OpenAPI
$ rake rswag

# Take a look at the generated OpenAPI
cat swagger/api/swagger.yaml

Preview the API reference docs on Bump.sh.

License

The contents of this repository are licensed under CC BY-NC-SA 4.0.