Visualize FastAPI endpoints with FastAPI-Voyager(newsyeah.fun)
newsyeah.fun
Visualize FastAPI endpoints with FastAPI-Voyager
https://www.newsyeah.fun/voyager/
24 comments
I would appreciate some quick info what this is all about. Clicking on link presents me with a huge diagram i know nothing about. What am I looking at?
this project is inspired by https://apis.guru/graphql-voyager/, which visualize the entity relationships based on graphviz and add fancy ui effects.
fastapi-voyager, from left to right, is tag, routes(apis) and response_models, it indicates the internal relationship between routes, which can help developers/PO easily figure out the data structure.
fastapi-voyager, from left to right, is tag, routes(apis) and response_models, it indicates the internal relationship between routes, which can help developers/PO easily figure out the data structure.
ok, how is this better than OpenAPI schema???
in swagger, from the definition of schema you are not able to easily figure out the related class, the name is marked as <object> or array<object>
in voyager their relationships are visualized and very close to the source code.
in voyager their relationships are visualized and very close to the source code.
What are the files like router.sample_1.schema? Is that a convention you use for your Pydantic models or something generated by OpenApi?
https://github.com/allmonday/composition-oriented-developmen...
those are clusters based on modules, you can swith off by toggle 'show module cluster'
those are clusters based on modules, you can swith off by toggle 'show module cluster'
So this isn't really "visualize FastAPI endpoints", it's "visualize the inheritance cascade caused by using the pydantic-resolve approach to data fetching/transformation, which involves adding post-hooks to compositions of Pydantic objects". A vanilla FastAPI user like myself is going to have trouble understanding it without realizing how tied it is to that framework.
to better describe the relationship, it borrows the concept 'subset' from pydantic-resolve, which act like pick several fields from original class but you can still reference to it.
@subset(User) class PickedUser: ....
@subset(User) class PickedUser: ....
it's not bound with pydantic-resolve, for vanilla fastapi user if the business model are well designed and composed, it can benefited from this visualization approach too.
the goal is to make the dependencies clear for developers, and figure out the potential impacts from one node to others.
pydantic-resolve is just another my project to make the process of data composition close to ER model and get rid of glue codes like 'for loops'.
the goal is to make the dependencies clear for developers, and figure out the potential impacts from one node to others.
pydantic-resolve is just another my project to make the process of data composition close to ER model and get rid of glue codes like 'for loops'.
This seems to show much deeper into the backend... OpenAPI really only shows the API surface as kind of a black box for external usage... this seems to be to aid diagnostics and understanding of internal calls and relationships.
you are right, in fact the most valuable part in our backend is 'business mode/logic', with voyager we can have a new choice to better understand them.
Pretty nice
if you double click route / pydantic class and click 'view in vscode', it will lead you to the file in github
and in local env, you can 'really' open it in vscode.
and in local env, you can 'really' open it in vscode.
Needs more discovery interactions - first one being node mouseover highlights all associated links.
It's 2025, I don't want to look at a giant hairball. At top level, give me a summary, reveal detail as I drill down.
Am I using this as a reference? The search looks promising, I can follow thru and find specifics on a particular item I am after.
It's 2025, I don't want to look at a giant hairball. At top level, give me a summary, reveal detail as I drill down.
Am I using this as a reference? The search looks promising, I can follow thru and find specifics on a particular item I am after.
thanks for suggestion. this project is still in early stage, I've listed some ux related Todos but not yet finished.
TBH, i dont expected it to be noticed in hacker's news LOL
There has to be a better way to view this than the tangled web of overlapping lines, like that at lower left of the "services" rectangle on the right, even with the selection highlighting. Perhaps there is not, and it is fertile ground for developing a new visualization.
Click any node, and everything not related to that node fades.
The tangled mess kind of picture is still sometimes useful: you can roughly see bunches grouped, and notice things that are all over the place.
The tangled mess kind of picture is still sometimes useful: you can roughly see bunches grouped, and notice things that are all over the place.
heere is the repo: https://github.com/allmonday/fastapi-voyager
Mapping software in /src/ modding, either with GIS software for positional API voyaging, which designate the tiers for endpoints.
Is that de Chrome-only webapp ? Does not seem to work with Firefox.
nice tool, everyone writing web service with FastAPI should take a try : )
scroll to zoom in/out
pick tag/routes at left panel, and see subgraphs
double click to see field table and source code, click link to see source code in github
click focus to hide other nodes.
...
pick tag/routes at left panel, and see subgraphs
double click to see field table and source code, click link to see source code in github
click focus to hide other nodes.
...