Search code examples
apiasyncapi

How to share an `AsyncAPI` documentation with others?


Is there any way to share an AsyncAPI documentation with others? I used AsyncAPI Studio to write my API documentation. But I couldn't found a share option in AsyncAPI studio. Is there a way in AsyncAPI Studio/any other AsyncAPI editors that we can used to share our API documentation with others?

In SwaggerHub we can share our rest api documentation with others which was written using OpenAPI specifications.


Solution

  • Yes you have the possibility but limited. Studio doesn't save your specs in the cloud (there is no server for that), but if your spec is shared somewhere via http then you can use the url parameter with the readOnly parameter - the latter determines whether studio should render the spec with or without an editor.

    It is also possible to use the base64 parameter, but only for small specifications due to the limited length of links.

    Example: