Skip to main content

OpenAPI Documentation

ยท One min read
The Rage Team
The Rage Team

Version 1.11.0 brings Rage::OpenAPI for API documentation. The goal was to make documenting APIs less painful - you document your APIs using YARD-style tags, and it generates OpenAPI 3.0 specs automatically.

What makes it nice:

  • Automatic generation based on route definitions
  • Swagger UI Integration
  • No need to maintain separate documentation files

It integrates directly with your controllers, so the documentation stays close to the code it describes.