System Map

Docit can now render a local architecture graph for your Rails API. It connects routes, controllers, actions, documentation coverage, schemas, models, and source references so engineers can understand how the app fits together.

Available routes

What the graph includes

• Routes mapped to controller actions
• Controller-to-action relationships
• Docit documentation coverage for each action
• Schema nodes from Docit.define_schema
• Loaded ActiveRecord models and associations
• Service, job, and mailer nodes from local source folders
• Evidence and confidence on every edge

Configuration

Docit.configure do |config|
  config.system_graph_enabled = true
  config.system_graph_excluded_paths = [
    "app/controllers/internal/"
  ]
end

Two views

• Diagram — an interactive architecture graph. Drag nodes to rearrange, scroll to zoom, and click a node to inspect its connections (its neighbours highlight while the rest fade back). Filter to a single resource with the section dropdown, or press / to search nodes.
• Docs — a request/response reference grouped by resource. Each endpoint shows a human-readable title, its method and path, parameters, request body, and responses, drawn from your Docit docs. A coverage indicator shows how many endpoints in each section are documented.

The map ships with a light and dark theme (light by default) and a toggle that persists across visits. Use Export PNG to download the current diagram.