https://github.com/cap-js/asyncapi
https://github.com/cap-js/asyncapi
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cap-js/asyncapi
- Owner: cap-js
- License: apache-2.0
- Created: 2024-02-05T05:33:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-29T08:20:22.000Z (12 months ago)
- Last Synced: 2024-05-29T20:58:21.028Z (12 months ago)
- Language: JavaScript
- Size: 76.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://api.reuse.software/info/github.com/cap-js/asyncapi)
# AsyncAPI
## About this project
The `@cap-js/asyncapi` is a package that provides support for AsyncAPI document compilation.
### Table of Contents
- [Requirements and Setup](#requirements-and-setup)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Licensing](#licensing)
## Requirements and Setup
### Installation
```sh
$ npm install @cap-js/asyncapi
```
### Usage
```js
const cds = require('@sap/cds')
const { compile } = require('@cap-js/asyncapi')
```
```js
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](https://github.com/cap-js/asyncapi/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](CONTRIBUTING.md).
## 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](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
## Licensing
Copyright 2024 SAP SE or an SAP affiliate company and contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/asyncapi).