Any interest in supporting `AsyncAPI`?

[ForsakenHarmony]

trafficstars

https://www.asyncapi.com/

Currently evaluating some options for api documentation, for now we just need openapi docs, but in the future we might want to add asyncapi

redoc looks a bit nicer in terms of ux, but https://github.com/Mermade/widdershins already supports AsyncAPI, so was wondering if you had any plans for supporting it in the (near) future

[RomanHotsiy]

@ForsakenHarmony yes. We are considering AsyncAPI support.

Hopefully, we can start working on this on Q3 this year.

[derberg]

@RomanHotsiy I'm AsyncAPI maintainer. In case you need some consulting, some explanation, something that will help you out to kick off with this one, let me know. You can reach me out in our slack https://www.asyncapi.com/slack-invite/ or just ping me here if you want

[RomanHotsiy]

@derberg thanks for your help! I will definitely contact you once we start working on this and need any help!

[GordeevArt]

Please make support of Avro-schemas in async-api:

async-api.yaml:

...

components:
  messages:
    event-message:
      schemaFormat: Avro
      payload:
        $ref: 'event-message.avsc'

event-message.avsc:

{
  "namespace": "com.example",
  "type": "record",
  "fields": [...]
}

[adaliszk]

Hey @RomanHotsiy, what is the new timeline for this? I really like your UX and Design and would be awesome if we could use ReDoc as a universal documentation generator from the API specifications.

[typekpb]

AsyncAPI protocol: amqp would be definitely of our interest

[gomete]

Hi @typekpb!

A colleague has forked ReDoc repo and he created a version that supports both OpenAPI and AsyncApi: https://github.com/ivamuno/redoc-asyncapi.

There is a npm package published with the latest version: https://www.npmjs.com/package/redoc-asyncapi.

There are some changes that have been done in the document structure to support both specifications but we tried to include the minimum changes as possible if someday it can be merged into the main project.

Hope it is useful for you!

[felixjung]

At this point the AsyncAPI folks offer a pretty nice React component themselves. Personally I don't mind rendering different components based on which API spec someone is looking at.

[antonrud]

We need this in my company as well!

[derberg]

Whoever picks that up at Redocly. Keep in mind that at AsyncAPI Initiative we maintain a react component for that, and also make sure it is usable in other frameworks. Most important is that we want custom styling to be a core feature. So do not try to write everything on your own (AsyncAPI is more complex than OpenAPI) but rather join us in development and maintenance 🚀

Even if you decide you want to do it on your own, feel free to talk to us and consult so we can share our experience and make your life's easier 😄

[mdovhopo]

Hi. Is there any more info on this issue? We are considering enterprise redocly, to render OpenAPI docs and more and i think we will need to have AsyncAPI support as well. Thank you

[Planxnx]

+1

[LeDwel]

+1

[jlucidar]

It seems that AsyncAPI v3.0.0 support has been added to redocly-cli. So I guess we can expect full support of asyncAPI in redoc sson ? This is great news 😄