OAS Rails

Generate Automatic Interactive Documentation for Your Rails API

OasRails is a Rails engine for generating automatic interactive documentation for your Rails APIs. It generates an OAS 3.1 document and displays it using RapiDoc.

What you get

• ApiPie: Doesn't support OAS 3.1, requires learning a DSL, lacks a nice UI
• swagger_yard-rails: Seems abandoned, but serves as inspiration
• Rswag: Not automatic, depends on RSpec; Many developers now use Minitest as it's the default test framework
• grape-swagger: Requires Grape
• rspec_api_documentation: Requires RSpec and a command to generate the docs

Installing it

# Gemfile
gem "oas_rails"

Details

200 stars on GitHub · MIT licensed · maintained by a-chacon. Source: https://github.com/a-chacon/oas_rails