[DISCUSS] OpenAPI Generator

[lewismc]

Hi Folks,
I am working with the ASF Treasury and will likely be using this framework for building services to streamline some Treasury workflows.
For a number of years I've really enjoyed using the OpenAPI Generator project. The availability of an OpenAPI document helps on so many levels.
For Python, I've used several of the server generators incl. python-flask, which is fairly similar to Quart.
I wonder... has anyone thought about building an OpenAPI Generator for infrastructure-asfquart which would unlock auto-generating server stubs given an OpenAPI document?
Thanks for any discussion.

[netomi]

In the ATR project we use also asfquart as base and integrate Quart-Schema to to add validation to routes and generate open api documentation, see

https://github.com/apache/tooling-trusted-release/blob/main/atr/server.py#L82

happy to help out with this.

Integration is really easy, and you can then use validation like here: https://github.com/apache/tooling-trusted-release/blob/main/atr/blueprints/api/api.py#L46

The only annoying thing is that the pydantic models are not automatically converted to json responses, see pgjones/quart-schema#91

So you need to do that by hand.

[lewismc]

Ah OK. Thank you @netomi .
You don't start with the OpenAPI doc but you generate one from the Python endpoints. Thanks for the pointer.

[netomi]

If you want to generate a quart service based on an existing OpenAPI schema the links I sent you will not really help, but maybe they give you some ideas.

[dave2wave]

I've playing with this on a side project with CHatGPT's help. It has a lot of hallucination with asfquart, but I'm making progress with openapi endpoints.