跳到导航
AsyncAPI扩展

API Explorer control

以 Markdown 格式查看

The API Explorer is enabled by default for every WebSocket channel. Set x-fern-explorer: false at the document root to hide the Playground for all channels, and override it on individual channels; a channel’s own value takes precedence. Non-boolean values are reported as errors when importing the specification.

asyncapi.yml
asyncapi: 3.0.0
info:
  title: Plant Store API
  version: 1.0.0
x-fern-explorer: false  # Disable the Explorer for all channels
channels:
  plantMonitor:
    address: /plants/monitor
    x-fern-explorer: true  # Enable the Explorer for this channel
    messages:
      moistureReading:
        $ref: "#/components/messages/MoistureReading"
  plantUpdates:
    address: /plants/updates  # Remains disabled (document-level value applies)
    messages:
      statusUpdate:
        $ref: "#/components/messages/StatusUpdate"