Skip to content
Last updated

asyncapi

Deprecated plugin

This page refers to the legacy Redocly AsyncAPI plugin.

AsyncAPI documentation is now supported natively in Realm and requires no configuration. For information on how to add AsyncAPI description files to your project, see: Add AsyncAPI descriptions. To migrate to native support for AsyncAPI documentation, see: Migrate to built-in AsyncAPI docs.

Customize the behavior and appearance of AsyncAPI documentation. Requires an AsyncAPI definition.

Options

OptionTypeDescription
schemaIdStringSchema ID. Defaults to asyncapi.
hideInfoBooleanSet to true to hide info section including API title.
hideOperationsBooleanSet to true to hide Operations section
hideServersBooleanSet to true to hide Servers section
hideMessagesBooleanSet to true to hide Messages section
hideSchemasBooleanSet to true to hide Schemas section

Examples

Change default schema id and hide servers section

plugins:
  # Enable plugin in project
  - '@redocly/portal-plugin-async-api/plugin.js'
asyncapi:
  schemaId: StreetlightAPI
  hideServers: true

Change default schema id and show all the sections except schemas section

plugins:
  # Enable plugin in project
  - '@redocly/portal-plugin-async-api/plugin.js'
asyncapi:
  schemaId: StreetlightAPI
  hideErrors: false
  hideInfo: false
  hideOperations: false
  hideServers: false
  hideMessages: false
  hideSchemas: true

Resources

  • AsyncAPI docs plugin - Learn about the AsyncAPI documentation plugin for integrating event-driven API documentation
 
Next page