Project

oas_rage

0.0
No release in over 3 years
OasRage is a ruby gem for generating automatic interactive documentation for your Rage APIs. It generates an OAS 3.1 document and displays it using RapiDoc.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

~> 5.0, >= 5.0.1
~> 2.0
~> 0.5.2
 Project Readme

Gem Version GitHub License GitHub Actions Workflow Status Gem Total Downloads Static Badge Static Badge

šŸ“ƒOpen API Specification For Rage

OasRage is a tool for generating automatic interactive documentation for your Rage APIs. It generates an OAS 3.1 document and displays it using RapiDoc.

Built for the high-performance Rage framework, OasRage leverages Rage's compatibility with Rails and its modern Ruby features, including fiber scheduling for non-blocking I/O. It relies on the OasCore gem for seamless OpenAPI integration.

Screenshot

Documentation

For details on how to install, configure, and use OasRage, please refer to the OasCore MDBook.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star⭐! Thanks again!

If you plan a big feature, first open an issue to discuss it before any development.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

The gem is available as open source under the terms of the GPL-3.0.

Star History

Star History Chart