AsyncAPI Bundler #128
Closed
Souvikns
started this conversation in
zArchived - AsyncAPI Hack 2021 - Submissions
Replies: 1 comment
-
Can't wait for this, going to be great! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
AsyncAPI Bundler
repo: https://github.com/Souvikns/asyncapi-bundler
Introduction
With AsyncAPI Bundler combine multiple specification files into one. It also resolves external
$refs
so you can also use it to bundle all references from a single AsyncAPI document into a single file as talked here.Usage Example
I would like to demonstrate two different ways to use AsyncAPI Bundler.
1. Combine multiple complete AsyncAPI specifications into one document.
This use case was inspired by Zorabots, zbos-mqtt-api where they have multiple AsyncAPI documents for each interface which is easy to maintain and develop, but customers do not want to see the complexity of the system as it is adding noise. Customers want to see the system as on big API. This is what the AsyncAPI Bundler aims to solve by providing a way to merge multiple AsyncAPI documents.
Some things to consider
Example
CLI Command
Files
2. Bundle all references from a single AsyncAPI document into a single file.
From the above example, each individual AsyncAPI document could in turn depend on external reference which needs to be resolved before merging. Inspired by @magicmatatjahu idea we can solve both use cases simultaneously.
Some things to consider
$ref
pointing to other external files might not be complete.Example
CLI Command
Files
Future of the Project
If the project is liked and it serves any purpose, I would like to donate the project to AsyncAPI Initiative or port the logic to parser-js to further develop and maintain the project.
Next Feature that I would work on
Thanks to -
Beta Was this translation helpful? Give feedback.
All reactions