https://github.com/a-chacon/oas_hanami

Generate Automatic Interactive Documentation for Your Hanami API
https://github.com/a-chacon/oas_hanami

hanami hanami-api oas open-api-specification ruby rubygem

Last synced: 6 days ago
JSON representation

Generate Automatic Interactive Documentation for Your Hanami API

• Host: GitHub
• URL: https://github.com/a-chacon/oas_hanami
• Owner: a-chacon
• License: gpl-3.0
• Created: 2025-06-11T22:00:59.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-07-01T02:14:38.000Z (9 months ago)
• Last Synced: 2025-12-04T13:57:02.157Z (3 months ago)
• Topics: hanami, hanami-api, oas, open-api-specification, ruby, rubygem
• Language: Ruby
• Homepage: https://a-chacon.com/oas_core
• Size: 4.98 MB
• Stars: 6
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Gem Version](https://img.shields.io/gem/v/oas_hanami?color=E9573F)

![GitHub License](https://img.shields.io/github/license/a-chacon/oas_hanami?color=blue)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/a-chacon/oas_hanami/.github%2Fworkflows%2Fruby.yml)

![Gem Total Downloads](https://img.shields.io/gem/dt/oas_hanami)

![Static Badge](https://img.shields.io/badge/Hanami-%3E%3D2.0.0-%23E9573F)

![Static Badge](https://img.shields.io/badge/Ruby-%3E%3D3.1.0-%23E9573F)

# 📃Open API Specification For Hanami

OasHanami is a tool for generating **automatic interactive documentation for your Hanami APIs**. It generates an **OAS 3.1** document and displays it using **[RapiDoc](https://rapidocweb.com)**.

It relies on the [OasCore](https://github.com/a-chacon/oas_core).

![Screenshot](https://a-chacon.com/oas_core/assets/hanami_theme.png)

## Documentation

For details on how to install, configure, and use OasHanami, please refer to the [OasCore MDBook](http://a-chacon.com/oas_core).

## 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](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text).

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=a-chacon/oas_hanami&type=Date)](https://www.star-history.com/#a-chacon/oas_hanami&Date)