Publishing to AsyncAPI ​

You can convert events in CDS models to the AsyncAPI specification, a widely adopted standard used to describe and document message-driven asynchronous APIs.

CDS Type to AsyncAPI Mapping ​

Usage from CLI ​

Use the following command to convert all services in srv/ and store the generated AsyncAPI documents in the docs/ folder:

cds compile srv --service all -o docs --to asyncapi

For each service that is available in the srv/ files, an AsyncAPI document with the service name is generated in the output folder. If you want to generate one AsyncAPI document for all the services, you can use --asyncapi:merged flag:

cds compile srv --service all -o docs --to asyncapi --asyncapi:merged

Learn how to programmatically convert the CSN file into an AsyncAPI Document

Presets ​

Use presets to add configuration for the AsyncAPI export tooling.

{
  "export": {
    "asyncapi": {
      "application_namespace": "sap.example"
      ...
    }
  }
}

Annotations ​

Use annotations to add configuration for the AsyncAPI export tooling.

For example:

@AsyncAPI.Title        : 'CatalogService Events'
@AsyncAPI.SchemaVersion: '1.0.0'
@AsyncAPI.Description  : 'Events emitted by the CatalogService.'

service CatalogService {
  @AsyncAPI.EventSpecVersion    : '2.0'
  @AsyncAPI.EventCharacteristics: {
    ![state-transfer]: 'full-after-image'
  }
  @AsyncAPI.EventSchemaVersion       : '1.0.0'

  event SampleEntity.Changed.v1 : projection on CatalogService.SampleEntity;
}