APIkit for AsyncAPI Error Handling Reference

APIkit for AsyncAPI maps runtime failures to typed errors that cover validation, publishing, routing, and internal faults. Use the table to diagnose which phase failed and adjust your AsyncAPI implementation or flow configuration.

Error Type	Description
INTERNAL_SERVER_ERROR	Internal error.
VALIDATION_ERROR	The payload doesn’t meet the schema of the API spec.
PUBLISHING_ERROR	APIkit fails to publish messages on the selected channel.
ROUTING_ERROR	APIkit fails to route messages to the flows.

Error Type

Description

INTERNAL_SERVER_ERROR

Internal error.

VALIDATION_ERROR

The payload doesn’t meet the schema of the API spec.

PUBLISHING_ERROR

APIkit fails to publish messages on the selected channel.

ROUTING_ERROR

APIkit fails to route messages to the flows.

APIkit for AsyncAPI Error Handling

The APIkit for AsyncAPI scaffolder does not generate error-handling code. Add on-error components and scopes in your Mule application as needed.

Kafka Limitations

If you enable content validation, the Source Message Listener (the component that consumes messages from Kafka topics) doesn’t throw an exception for invalid messages. Consequently, you can’t implement the DLQ/DLT pattern for Kafka in this scenario. Instead, the consumer must route invalid messages to DLQ/DLT topics.