Show HN: FastOpenAPI – automated docs for many Python frameworks
1–10 of 85 posts
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#2Hey everyone!
While working on a project that required OpenAPI docs across multiple frameworks, I got tired of maintaining separate solutions. I liked FastAPI’s clean and intuitive routing, so I built FastOpenAPI, bringing a similar approach to other Python frameworks (Flask, Sanic, Falcon, Starlette, etc).
It's meant for developers who prefer FastAPI-style routing but need or want to use a different framework.
The project is still evolving, and I’d love any feedback or testing from the community!
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#3This is really cool - something I've been looking for with Flask. Cleanest implementation with just the decorator that I've seen.
(As an aside, is there an open-source UI for docs that actually looks good - professional quality, or even lets you try out endpoints? All of the decent ones are proprietary nowadays.)
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#4This is really cool - something I've been looking for with Flask. Cleanest implementation with just the decorator that I've seen. (As an aside, is there an open-source UI for docs that actually looks good - professional quality, or even lets you try out endpoints? All of the decent ones are proprietary nowadays.)
Thanks a lot! Glad to hear it fits your needs.
For a clean, documentation UI, the best open-source options right now are probably Swagger UI and ReDoc. FastOpenAPI uses both by default:
- Swagger UI: interactive, lets you try out endpoints live. - ReDoc: more minimalist and professional-looking but static.
If you're looking for something different, you might check out RapiDoc, which is also open-source, modern, customizable, and supports interactive API exploration.
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#5Why not just use fastAPI and have it built into the framework?
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#6Hey everyone! While working on a project that required OpenAPI docs across multiple frameworks, I got tired of maintaining separate solutions. I liked FastAPI’s clean and intuitive routing, so I built FastOpenAPI, bringing a similar approach to other Python frameworks (Flask, Sanic, Falcon, Starlette, etc). It's meant for developers who prefer FastAPI-style routing but need or want to use a different framework. The p…
for someone that comes primarily from a .net background. This looks fantastic!
Just one thing that I tried to find more information about is: are you suppose to rely on the prefix for specifying api version?
Disclaimer: I'm on a phone while writing this, so I just might have missed something obvious
other then that, kudos for releasing this package!
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#7Nice work! What's your take on spec-first vs. code-first?
I'm a fan of spec-first (i worked on connexion), but I've noticed that code-first seems to be more popular.
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#8Why not just use fastAPI and have it built into the framework?
It sounded to me like they need to retrofit several projects written in different python servers.
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#9Hey everyone! While working on a project that required OpenAPI docs across multiple frameworks, I got tired of maintaining separate solutions. I liked FastAPI’s clean and intuitive routing, so I built FastOpenAPI, bringing a similar approach to other Python frameworks (Flask, Sanic, Falcon, Starlette, etc). It's meant for developers who prefer FastAPI-style routing but need or want to use a different framework. The p…
for someone that comes primarily from a .net background. This looks fantastic! Just one thing that I tried to find more information about is: are you suppose to rely on the prefix for specifying api version? Disclaimer: I'm on a phone while writing this, so I just might have missed something obvious other then that, kudos for releasing this package!
In the examples, I used prefixes to demonstrate API versioning, but you're not limited to this approach. Prefixes can be used for general route structuring as well (like grouping entities, etc.), not just for versioning.
Personally, I prefer using router composition for flexible route organization. You can see a clear example of this with Flask here: https://github.com/mr-fatalyst/fastopenapi/tree/master/examp...
In this example, routes are split into routers by entities, which are then grouped into an api_v1 router, and finally, this api_v1 router is added to the main router.
Re: Show HN: FastOpenAPI – automated docs for many Python frameworks
#10No love for Django? I am looking for an alternative to DRF and Django-ninja that can optionally generate typed APIs and docs directly from the model definitions.