AsyncAPI

About this project

The @cap-js/asyncapi is a package that provides support for AsyncAPI document compilation.

Table of Contents

• Requirements and Setup
• Contributing
• Code of Conduct
• Licensing

Requirements and Setup

Installation

$ npm install @cap-js/asyncapi

Usage

const cds = require('@sap/cds')
const { compile } = require('@cap-js/asyncapi')

const csn = await cds.load(cds.env.folders.srv)
const asyncapiDocument = compile(csn)

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 2024 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.

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. The format is based on Keep a Changelog.

Version 1.0.3 - 12-03-2025

Added

• Added defaults for @AsyncAPI.SchemaVersion and @AsyncAPI.Title.

Changed

• Replaced console.warn statements with cds.debug logs for warning messages.

Version 1.0.2 - 15.07.2024

Changed

• Changed default namespace from sap.app to customer.<package-name>
• Changed default namespace regex making it compatible with ORD.

Version 1.0.1 - 14.05.2024

Changed

• Removed registering compile target

Version 1.0.0 - 02.05.2024

Added

• Initial release