{"repo":"a-chacon/oas_rails","free":true,"listed":false,"github":"https://github.com/a-chacon/oas_rails","clone":"git clone https://github.com/a-chacon/oas_rails.git","description":"Generate Automatic Interactive Documentation for Your Rails API","language":"Ruby","stars":201,"topics":["api","api-rest","documentation","oas","oas3","rails","ruby","swagger","swagger-ui","openapi"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"📃Open API Specification For Rails 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 . It relies on the OasCore gem. 🚀 Demo App Explore the interactive documentation live: 🔗 Open Demo App 👤 Username : oasrails 🔑 Password : oasrails 🎬 A Demo Installation/Usage Video: 🎬 Related Projects - 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 What Sets OasRails Apart? - Dynamic : No command required to generate docs - Simple : Complement default documentation with a few comments; no need to learn a complex DSL - Pure Ruby on Rails APIs : No additional frameworks needed (e.g., Grape, RSpec) 📽️ Motivation After experiencing the interactive documentation in Python's fast-api framework, I sought similar functionality in Ruby on Rails. Unable to find a suitable solution, I asked on Stack Overflow years ago. Now, with some free time while freelancing as an API developer, I decided to build my own tool. Note: This is not yet a production-ready solution. The code may be rough and behave unexpectedly, but I am actively working on improving it. If you like the idea, p","default_branch":null,"files":null,"tree":[],"storefront":"/r/a-chacon","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/a-chacon/oas_rails/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}