[📑 Docs]: Is there any documentation on how to use it?

[Yuutakasan]

What Dev Docs changes are you proposing?

I am currently working on a mechanism for OpenAPI and AsyncAPI to work together.Originally, I was using OpenAPI Generator, but I am planning to migrate to AsyncAPI Generator to create a mechanism that can be used in conjunction with OpenAPI and AsyncAPI.
I am looking for a mechanism that can parse OpenAPI Spec, and I thought this mechanism could be useful, but I don't know how to use it.
Could you please document it for me or give me some simple instructions on how to use it?

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[derberg]

Hey @Yuutakasan

this project focus on supporting reusability of OpenAPI Schema (just for message payloads) inside AsyncAPI.

I guess you're looking for OpenAPI -> AsyncAPI converter, is that right?

[Yuutakasan]

@derberg

I finally understood it after trying last week. Thank you for your reply.

Currently, I am developing a system that operates backend requests through event sourcing and asynchronous processing after requesting an OpenAPI Spec. At the moment, I only have a program that processes using the OpenAPI generator and it is written with the OpenAPI generator, but now, I am trying to automatically generate programs using the AsyncAPI generator based on the AsyncAPI Spec.

It is necessary for the OpenAPI Spec and AsyncAPI Spec to work together. I do not want to maintain both the interface definitions and the programs separately, so I would like to find a way to output both the OpenAPI Spec and AsyncAPI Spec from a single generator.

Therefore, I am exploring whether the AsyncAPI generator can handle both the OpenAPI Spec and AsyncAPI Spec. The current direction of investigation is as follows:

1. Enable the AsyncAPI generator to parse the OpenAPI Spec and automatically generate programs.
2. Convert the OpenAPI Spec to the AsyncAPI Spec and use the AsyncAPI Generator for automatic generation.

Currently, I am trying to achieve the above point 1 by modifying the OpenAPI Schema parser to an OpenAPI Spec parser.

If you can think of any other methods, I would greatly appreciate your guidance.

[derberg]

Hey, thanks for sharing all the details

In AsyncAPI Generator there is no discussion about supporting OpenAPI atm - that would cause some more complexity to codebase and also not many people request it.

I suggest option 2. And actually we have a bounty issue for it (advanced which means we can pay $400 for the work) -> asyncapi/converter-js#233
You can join our Slack and chat in DM with Jonas who submitted the issue.