Async API Builder #136
Closed
anandsunderraman
started this conversation in
zArchived - AsyncAPI Hack 2021 - Submissions
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
GOAL
To create a wizard like UI that can make it easy for users to define an AsyncAPI spec without having to know the details about it.
This will reduce the barrier for folks to create / adopt Async API Spec initially
Implementation
This implementation is a PR on the Async API Studio project
As part of this implementation there are 3 panes created
For each pane there is a
Spec Output
pane that immediately shows what the spec output looks like.Info
Here we ask the user to gives us basic information about the Async API Spec
Message
Here user is asked to give a sample json message of the event and we generate the JSON schema and its YAML equivalent at the back
Channel
Here the user is asked to define the operations (publish / subscribe), the protocol and channel specific bindings. Currently for the hackathon we have implemented only basic options from 2 protocols
amqp
andmqtt
.Integration With Studio
Finally the user can click on
View In Studio
option to view the defined spec in the studio.Demo
demo.mp4
To view screenshots and a demo of this app please view this google slide https://docs.google.com/presentation/d/1-SrPr2hbMvVGjmstjHgBZcEs78Q0BPoDE2-9Jmv4s4U
Code submission
asyncapi/studio#135
Participants:
Anand Sunderraman @anandsunderraman
Janavi Anand https://github.com/janavianand
Beta Was this translation helpful? Give feedback.
All reactions