Live data from Hacker News

Show HN: FastOpenAPI – automated docs for many Python frameworks

github.com

81–85 of 85 posts

Re: Show HN: FastOpenAPI – automated docs for many Python frameworks

#81
post #75

Earlier quoted context omitted.

I do the opposite and leave generating openapi docs to an LLM. Mostly that just involves spelling out the obvious; so it's not a particularly hard job for an LLM. The code is the full specification of what a thing does. Anything else is just a watered down version of the thing. In architecture terms, there is no blue print for the blue print, typically. This is a fundamental misconception some people have about softw…

I think you might have a fundamental misunderstanding about what OpenAPI specs are for. If you just need docs then maybe that works for you. OpenAPI can do so much more though - it can specify a protocol. If you can't see why a protocol specification is different from an implementation of that protocol then I don't know what to tell you.

Most uses of OpenAPI I've seen is simple REST API documentation.

Many internet standards & protocols are typically developed together with their reference implementation. E.g. the IETF is pretty good at that for things like HTTP. Waterfall just doesn't work for anything moderately complicated.

If it's simple, a lot of upfront documentation is not going to be that helpful. If it's not, a proof of concept implementation that irons out all the design mistakes and that proves it is any good would be a good idea. There aren't a lot of good protocols that get developed without those.

Anyway, the article is about slapping openapi specs on python web frameworks, which suggests it's being used in its usual role of documenting existing APIs here. And for REST protocols, python is a great tool to prototype those.

Re: Show HN: FastOpenAPI – automated docs for many Python frameworks

#82
That's really neat! I made a project for fastapi-like dependency injection for AioHTTP and it also has OpenAPI spec generation. If I could, I would like to use your library for specs instead of self-written solution.

Here's my project repo: https://github.com/taskiq-python/aiohttp-deps

Re: Show HN: FastOpenAPI – automated docs for many Python frameworks

#83
post #82

That's really neat! I made a project for fastapi-like dependency injection for AioHTTP and it also has OpenAPI spec generation. If I could, I would like to use your library for specs instead of self-written solution. Here's my project repo: https://github.com/taskiq-python/aiohttp-deps

Thanks! I have a draft for aiohttp integration. I think I'll add it later.

Re: Show HN: FastOpenAPI – automated docs for many Python frameworks

#84
post #82

That's really neat! I made a project for fastapi-like dependency injection for AioHTTP and it also has OpenAPI spec generation. If I could, I would like to use your library for specs instead of self-written solution. Here's my project repo: https://github.com/taskiq-python/aiohttp-deps

I added the draft in 0.5.0-dev

https://github.com/mr-fatalyst/fastopenapi/tree/0.5.0-dev

Example: https://github.com/mr-fatalyst/fastopenapi/tree/0.5.0-dev/ex...

Post reply on HN