AsyncAPIExtensions

Overview of AsyncAPI extensions

Fern supports a variety of AsyncAPI extensions that enhance your API specification and generate higher-quality SDKs.

You can apply these extensions in two ways: by overlaying them in separate override files or by embedding them directly in your AsyncAPI specification. See Overrides for more information.

Available extensions

The table below shows all available extensions and links to detailed documentation for each one.

ExtensionDescription
x-fern-ignoreSkip reading specific operations, channels, or schemas
x-fern-examplesProvide additional examples for better SDK documentation
x-fern-paginationConfigure pagination for operations that return multiple results
x-fern-retryConfigure retry behavior for operations
x-fern-streamingMark operations as streaming for appropriate SDK generation
x-fern-error-handlingConfigure error handling for operations
x-fern-server-nameSpecify custom names for servers
x-fern-availabilityMark features as available in specific SDK versions
Request a new extension

If there’s an extension you want that doesn’t already exist, file an issue to start a discussion about it.