fastapi-voyager 0.9.3

Visualize FastAPI application's routing tree and dependencies

This repo is still in early stage, it supports pydantic v2 only

Inspect your API interactively!

Installation

pip install fastapi-voyager
# or
uv add fastapi-voyager

voyager -m path.to.your.app.module --server

Feature

For scenarios of using FastAPI as internal API integration endpoints, fastapi-voyager helps to visualize the dependencies.

It is also an architecture inspection tool that can identify issues in data relationships through visualization during the design phase.

If the process of building the view model follows the ER model, the full potential of fastapi-voyager can be realized. It allows for quick identification of APIs that use entities, as well as which entities are used by a specific API

git clone https://github.com/allmonday/fastapi-voyager.git
cd fastapi-voyager

voyager -m tests.demo 
           --server --port=8001 
           --module_color=tests.service:blue 
           --module_color=tests.demo:tomato

generate the graph

after initialization, pick tag, rotue to render graph

highlight

click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.

filter related nodes

shift click a node to check related node, pick a field to narrow the result, picked node is marked as red.

view source code

alt click a node to show source code or open file in vscode.

alt click a route to show source code or open file in vscode

Mount to target project

from fastapi import FastAPI
from fastapi_voyager import create_voyager
from tests.demo import app

app.mount('/voyager', create_voyager(
    app, 
    module_color={"tests.service": "red"}, 
    module_prefix="tests.service"))

more about sub application

Command Line Usage

open in browser

# open in browser
voyager -m tests.demo --server  

voyager -m tests.demo --server --port=8002

generate the dot file

# generate .dot file
voyager -m tests.demo  

voyager -m tests.demo --app my_app

voyager -m tests.demo --schema Task

voyager -m tests.demo --show_fields all

voyager -m tests.demo --module_color=tests.demo:red --module_color=tests.service:tomato

voyager -m tests.demo -o my_visualization.dot

voyager --version

The tool will generate a DOT file that you can render using Graphviz:

# Install graphviz
brew install graphviz  # macOS
apt-get install graphviz  # Ubuntu/Debian

# Render the graph
dot -Tpng router_viz.dot -o router_viz.png

# Or view online at: https://dreampuf.github.io/GraphvizOnline/

or you can open router_viz.dot with vscode extension graphviz interactive preview

Plan before v1.0

backlog

• user can generate nodes/edges manually and connect to generated ones
  • add owner
  • add extra info for schema
• display standard ER diagram hard
  • display potential invalid links
• support dataclass (pending)

in analysis

• click field to highlight links
• animation effect for edges
• customrized right click panel
  • show own dependencies
• clean up fe code

plan:

<0.9:

• group schemas by module hierarchy
• module-based coloring via Analytics(module_color={...})
• view in web browser
  • config params
  • make a explorer dashboard, provide list of routes, schemas, to make it easy to switch and search
• support programmatic usage
• better schema /router node appearance
• hide fields duplicated with parent's (show parent fields instead)
• refactor the frontend to vue, and tweak the build process
• find dependency based on picked schema and it's field.
• optimize static resource (cdn -> local)
• add configuration for highlight (optional)
• alt+click to show field details
• display source code of routes (including response_model)
• handle excluded field
• add tooltips
• route
  • group routes by module hierarchy
  • add response_model in route
• fixed left bar show tag/ route
• export voyager core data into json (for better debugging)
  • add api to rebuild core data from json, and render it
• fix Generic case test_generic.py
• show tips for routes not return pydantic type.
• fix duplicated link from class and parent class, it also break clicking highlight
• refactor: abstract render module

0.9

• refactor: server.py
  • rename create_app_with_fastapi -> create_voyager
  • add doc for parameters
• improve initialization time cost
  • query route / schema info through realtime api
  • adjust fe
• adjust layout (0.9.3)
  • show field detail in right panel
  • show route info in bottom

0.10

• support opening route in swagger
  • config docs path
• add http method for route
• enable/disable module cluster (may save space)
• logging information
• add tests
• hide brief mode if not configured
• optimize static resource
• show route count in tag expansion item
• route list show have a max height to trigger scrollable
• fix layout issue when rendering huge graph

0.11

• improve user experience
  • double click to show detail
  • improve search dialog

0.12

• integration with pydantic-resolve
  • show hint for resolve, post fields
  • display loader as edges

0.13

• config release pipeline
• [ ]

Using with pydantic-resolve

WIP: ...

pydantic-resolve's @ensure_subset decorator is helpful to pick fields from source class in safe.

Credits

• https://apis.guru/graphql-voyager/, thanks for inspiration.
• https://github.com/tintinweb/vscode-interactive-graphviz, thanks for web visualization.

Dependencies

• FastAPI
• pydantic-resolve
• Quasar

Changelog

• 0.9:
  • 0.9.3:
    • enhancement: better UI
  • 0.9.2:
    • fix: missing fields in schema detail panel
    • optimization: clean up fe codes.
  • 0.9.1:
    • api change: from create_app_with_fastapi to create_voyager, and expose as from fastapi_voyager import create_voyager
    • optimization: lazy load vscode link and source code, speed up the initialization.
• 0.8:
  • 0.8.3
    • upgrade theme
  • 0.8.2
    • fix silly typo.
  • 0.8.1
    • add feature: hide primitive routes
• 0.7:
  • 0.7.5
    • fix show all display issue
  • 0.7.4
    • optimize tag/route, move to left.
    • fresh on change, no need to click generate any more.
  • 0.7.3
    • fix module_color failure
  • 0.7.2
    • keep links inside filtered nodes.
  • 0.7.1
    • support brief mode, you can use --module_prefix tests.service to show links between routes and filtered schemas, to make the graph less complicated.
• 0.6:
  • 0.6.2:
    • fix generic related issue