Redoc: Any interest in supporting `AsyncAPI`?

Created on 30 Mar 2020  路  5Comments  路  Source: Redocly/redoc

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

feature

Most helpful comment

@ForsakenHarmony yes. We are considering AsyncAPI support.

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

All 5 comments

@ForsakenHarmony yes. We are considering AsyncAPI support.

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

@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

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

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": [...]
}

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.

Was this page helpful?
0 / 5 - 0 ratings