Rails API Documentation Should Be Easy
Automatically generate Swagger docs for your Ruby on Rails app with just simple drag & drop (and a powerful Ruby gem. 😉)
Simplify Your Documentation Journey with Cordyline
We want the documentatoin to be first citizen. So as soon as you plugged in the gem, a living documentation will be generated with the minimum info (groups, endpoint name, required parameters, etc).
Rich DSL
Your favorite Ruby powered syntax to define rich schema for API response and output. Seamlessly blends with Ruby, making crafting API responses incredibly simple. It's more than just syntax; it's a tool that optimizes your app's functionality, and makes API design a breeze.
_Ew0wD.png)
AI-Powered
Why writing documentation yourself when you can use AI to write it. With the built-in OpenAI integration, the gem will will parse the code and generate the adequate documentation based on context.
_EDKPT.png)
OpenAPI v3 Compatible
Fully compatible with OpenAPI v3 spec, so your team can leverage the rich and powerful ecosystem around it to generate client code, Postman Collections, static docs, etc.
Write your documentation with long term mindset.
We hate to treat API documentation as a one-off thing. We want documentation to evolve alongside the projects. And we have that covered for you.
Documentation Coverage ✅
You might know Test Coverage as a guard rail for software regression.
How about Documentation Coverage?
By setting a documentation coverage threshold. You won't need to worried about question like:
"How is this not documented at the first place?" OR "Where can I find the latest document?"
If it's not documented, it won't pass the CI.
Validation with Test 🚥
People make mistake while writing documentation. Or change implementation without changing the documentation. With that in mind, we allow you to run documentation validation with your test suite.
We will compare the runtime result happen withi the test run with the documentation schema. So if you either change request format or resposne payload, the validation will simply fail and notify you to update the doc accordingly.