search

mnahkies / openapi-code-generator

A code generation tool for openapi 3 / 3.1 specifications written in typescript, primarily aimed at generating typescript clients and server stubs. Other target languages may be added in future.
https://openapi-code-generator.nahkies.co.nz/
MIT License
20 stars 2 forks source link

Investigate supporting async api #59

Open mnahkies opened 1 year ago

mnahkies commented 1 year ago

Async API is a specification for describing event driven architecture, that aims to keep near compatibility with openapi specifications:

Part of this content has been taken from the great work done by the folks at the OpenAPI Initiative. Mainly because it's a great work and we want to keep as much compatibility as possible with the OpenAPI Specification.

It would be good to investigate adding support for this, possible templates could include:

https://www.asyncapi.com/docs/tutorials/getting-started/coming-from-openapi

ADRFranklin commented 1 year ago

I was looking to add this to one of my golang projects a while ago, but due to their limited support, they don't currently offer a standard or native websocket solution for it, instead they use watermil and only support RabbitMQ as the provider, which made it clear it wasn't an option without a custom template.

However for node, they already offer @asyncapi/nodejs-ws-template as a template, which is just a standard websocket solution with no third party requirements, which I would love to see this as an option here, if you do in the future plan to offer Async API with the generation.