RailsMap – Interactive API Documentation for Ruby on Rails

RailsMap is an open-source Ruby gem that automatically generates interactive API documentation for Ruby on Rails applications. By analyzing your application's routes, controllers, and models, RailsMap builds structured documentation that stays aligned with your codebase without requiring manual updates or complex configuration.

Instead of maintaining separate documentation tools, developers can instantly explore their API through a clean and organized interface. RailsMap helps teams understand application structure, inspect endpoints, and navigate resources quickly, making it especially useful for large Rails applications or teams onboarding new developers.

Key Features:

• Automatic API Documentation – Generates documentation directly from Rails routes, controllers, and models
• Route Explorer – View all application routes grouped by controllers with HTTP methods and paths
• Controller Documentation – Dedicated pages showing detailed route information for each controller
• Model Insights – Displays model attributes, associations, validations, and scopes
• API Parameter Detection – Automatically detects path, query, and request body parameters with inferred types
• Interactive Documentation UI – Clean interface for exploring endpoints and understanding API structure
• Static HTML Export – Generate shareable documentation that can be hosted or distributed easily
• Authentication Support – Secure documentation access with configurable authentication options
• Customizable Theme – Adjust primary theme colors to match your application branding
• Responsive Design – Optimized for both desktop and mobile viewing

Why RailsMap?

Maintaining API documentation manually can be time-consuming and often becomes outdated as applications evolve. RailsMap solves this by generating documentation directly from the Rails application structure, ensuring accuracy and reducing documentation overhead.

It allows development teams to:

• Quickly explore and understand existing APIs
• Improve onboarding for new developers
• Share API references internally or externally
• Keep documentation synchronized with the codebase

RailsMap aims to provide a lightweight, developer-friendly solution for automatic API documentation within the Ruby on Rails ecosystem.