Rails REST API documentation tool
Apipie-rails is a DSL and Rails engine for documenting your RESTful API. Instead of traditional use of #comments, Apipie lets you describe the code, through the code. This brings advantages like: * No need to learn yet another syntax, you already know Ruby, right? * Possibility of reusing the docs for other purposes (such as validation) * Easier to extend and maintain (no string parsing involved) * Possibility of reusing other sources for documentation purposes (such as routes etc.) The documentation is available from within your app (by default under the /apipie path.) In development mode, you can see the changes as you go. It's markup language agnostic, and even provides an API for reusing the documentation data in JSON.
Release | Stable | Testing |
---|---|---|
Fedora Rawhide | 0.8.1-6.fc40 | - |
Fedora 40 | 0.8.1-6.fc40 | - |
Fedora 39 | 0.8.1-4.fc39 | - |
Fedora 38 | 0.8.1-3.fc38 | - |
You can contact the maintainers of this package via email at
rubygem-apipie-rails dash maintainers at fedoraproject dot org
.