š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.
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
The gem is available as open source under the terms of the GPL-3.0.