@cap-js/asyncapi
Exports AsyncAPI documents describing the events a CAP service emits and consumes.
Facts
Where it sits
Who is behind it
In the atlas: maintains 34@cap-jsmaintainerAjinkya PatilContributes to this
In the atlas: contributes to 112@ajinkyapatil8190Christian GeorgiContributes to this
In the atlas: maintains 1, contributes to 53@chgeoChristian SchüringsContributes to this
In the atlas: contributes to 25@cschueringsDaniel O'GradyContributes to this
In the atlas: contributes to 10@daogradyGeethika PulaContributes to this
In the atlas: contributes to 2@Geethika-Pulajeevitha011Contributes to this
In the atlas: contributes to 6@jeevitha011RoshniNaveenaSContributes to this
In the atlas: contributes to 5@RoshniNaveenaSsidakphullContributes to this
In the atlas: contributes to 7@sidakphullsjvansContributes to this
In the atlas: contributes to 45@sjvansSteffen WaldmannContributes to this
In the atlas: contributes to 25@swaldmann10 contributors
Before choosing this
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 1, 2, 3A cds-plugin is used with SAP CAP materials, or an artifact is explicitly identified as a CAP plugin or application.
- § 1 License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.
- § 2 Intellectual Property. The agreement retains SAP's rights in the covered materials and limits making APIs, tools or software available to third parties, while preserving ownership of customer applications subject to SAP's underlying rights.
- § 3 Artificial Intelligence Training. The agreement prohibits use of the covered materials and customer applications for training artificial-intelligence models or systems.
What it declares
Every artifact
- Type
- CDS plugin
- Origin
- By SAP
- Runtime
- Node.js
As a CDS plugin
- Declared for
- >=7.6
- Distributed through
- npm
Connections
Emitting and consuming business events across systems through brokers
Describing a service for clients, registries and discovery
Download
Install
npm add @cap-js/asyncapiDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from cap-js/asyncapi under Apache-2.0, readAsyncAPI
About this project
The @cap-js/asyncapi is a package that provides support for AsyncAPI document compilation.
Table of Contents
Requirements and Setup
Installation
npm add -D @cap-js/asyncapi
See the AsyncAPI guide for the full documentation.
Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2026 SAP SE or an SAP affiliate company and contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
History
Features 3, Changed 2, Fixes 1
Notes
Added
- Support for
@AsyncAPI.ChannelNameannotation to allow custom channel names independent of message/schema references (enables channel names with special characters like slashes) - Support for
@Core.Descriptionannotation as an alternative to@description - Automatic resolution of i18n markers (e.g.,
{i18n>KEY})
Changed
- Event descriptions now only appear in
components.messages.<event>.description(removed fromcomponents.schemas.<event>.descriptionto avoid duplication) - Enum values now take precedence over they respective keys in the output
Fixed
- Fixed description collision bug where reused types (e.g., multiple properties with the same type but different
@descriptionannotations) would all end up with the same description from the last processed property. Now each property correctly maintains its individual description.
Features 1, Changed 1
Notes
Added
- Added defaults for
@AsyncAPI.SchemaVersionand@AsyncAPI.Title.
Changed
- Replaced
console.warnstatements withcds.debuglogs for warning messages.
- Added defaults for
Changed 2
Notes
Changed
- Changed default namespace from
sap.apptocustomer.<package-name> - Changed default namespace regex making it compatible with ORD.
- Changed default namespace from
Others providing
- com.sap.cds:cds-feature-ordcom.sap.cds:cds-feature-ordGenerates Open Resource Discovery (ORD) documents from a CAP Java application's model, a single entry point that a static metadata catalog or a runtime landscape inspection can read.sap official, capGenerates Open Resource Discovery documents from a CAP Java model
- @cap-js-community/common@cap-js-community/commonSix independent features for CAP services in one package: replication cache, migration check, rate limiting, a Redis client broker, a local HTML5 repository and a CDM builder.community org, capSix CAP features in one package, from replication cache to rate limits
- @cap-js/ord@cap-js/ordGenerates Open Resource Discovery documents from a CAP model.sap official, capGenerates Open Resource Discovery documents from a CAP model
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtime
- SAP Integration Suite, advanced event meshSAP Integration Suite, advanced event meshAn event streaming, event management and monitoring platform for event-driven architecture, offered within SAP Integration Suite.sap official, btpEvent streaming and management platform in Integration Suite
- Event MeshEvent MeshManaged queues and topics over AMQP, MQTT and a REST gateway, and the bus SAP's own applications publish their business events to.sap official, btpManaged queues and topics over AMQP, MQTT and REST
- com.sap.cds:cds-feature-advanced-event-meshcom.sap.cds:cds-feature-advanced-event-meshA beta CAP Java plugin that adds SAP Integration Suite, advanced event mesh as a messaging broker, activated by setting a messaging service's kind to aem.sap official, capCAP Java plugin for SAP Integration Suite, advanced event mesh
- com.sap.cds:cds-feature-enterprise-messagingcom.sap.cds:cds-feature-enterprise-messagingA CAP Java feature that connects a CAP messaging service to SAP Event Mesh, activated by setting the service's kind to enterprise-messaging, and looks up the bound instance.sap official, capConnects CAP Java messaging to SAP Event Mesh
- com.sap.cds:cds-feature-event-hubcom.sap.cds:cds-feature-event-hubA CAP Java plugin that connects CAP's messaging service to SAP Cloud Application Event Hub, so an application sends and consumes business events without coding against its API.sap official, capConnects CAP Java messaging to SAP Cloud Application Event Hub
- com.sap.cds:cds-feature-kafkacom.sap.cds:cds-feature-kafkaA CAP Java feature that connects a CAP messaging service to Apache Kafka for intra-application messaging, through the Apache Kafka client library rather than a managed SAP messaging service.sap official, capConnects CAP Java messaging to Apache Kafka
- com.sap.cds:cds-feature-rediscom.sap.cds:cds-feature-redisA beta CAP Java feature that connects a CAP messaging service to Redis Pub/Sub, which broadcasts each event to every subscribed instance and does not guarantee delivery.sap official, capBeta connector from CAP Java messaging to Redis Pub/Sub
- com.sap.cds:cds-services-bomcom.sap.cds:cds-services-bomThe Maven bill of materials for CAP Java, pinning every com.sap.cds module in a release, from the API and core runtime to the Spring Boot starters and the CQN engine, to the same version.sap official, capMaven bill of materials pinning CAP Java module versions
- @cap-js/advanced-event-mesh@cap-js/advanced-event-meshIntegrates CAP with SAP Integration Suite advanced event mesh.sap official, capCAP integration with SAP Integration Suite advanced event mesh
- @cap-js/event-broker@cap-js/event-brokerConsumes events from SAP Cloud Application Event Hub.sap official, capConsumes events from SAP Cloud Application Event Hub in CAP
- cds-kafkacds-kafkaA Kafka adapter for CAP that registers Kafka topics as a CDS messaging service over KafkaJS, so emit and on work unchanged, with per-message keys, partitions and topics set through headers.independent, capKafka adapter exposing topics as a CDS messaging service
- cds-event-monitoringcds-event-monitoringA CAP plugin that stores every event received on its configured messaging topics in a table, with a Fiori-annotated service to browse them, resend events and drain a dead-message queue.independent, capStores, browses and resends messages a CAP service receives
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtime
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:cap-js-asyncapi- JSON
- /artifacts/cap-js-asyncapi.json
- MCP
- Connecting an agent