Generating an OpenAPI/Swagger spec from a Ruby on Rails API

• rswag

  14 1,884 7.8 Ruby

  Seamlessly adds a Swagger to Rails-based API's

  

We will be creating a "Coffee Ordering API" using Ruby on Rails, and using a tool called rswag to create tests that verify the behaviour of our API and generate an OpenAPI reference.

• ruby-on-rails-openapi-example

  1 0 4.1 Ruby

  Demo project showing how to use rswag to generate an OpenAPI spec for a Ruby on Rails API

  

Note: You can view the source code for this tutorial on GitHub

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• rspec-rails

  19 5,111 8.7 Ruby

  RSpec for Rails 6+

  

This is where rswag comes in. It is an extension to rspec-rails for "describing and testing API operations".

• swagger-ui

  131 25,507 9.8 JavaScript

  Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

  

rswag also includes a bundled version of Swagger UI if you want to inspect your OpenAPI spec visually during testing.

Suggest a related project