Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding content for module 1 #6

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
19 changes: 19 additions & 0 deletions 100-level-AsyncAPI-Intro/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Eve is a programming genius renowned for her ability to solve various technical challenges. She lives at 7 Optimists Lane, Capuccinova.

The clock strikes 6 a.m. on a Monday, and the gentle notes of Lofi music gently rouse her from slumber.

After getting herself ready and brewing a cup of coffee, Eve casts a quick glance at the clock, only to realize that she's running behind schedule for her first work meeting with Guild. Guild happens to be one of the dedicated users of AsyncAPI, the organization where Eve acts as an open-source contributor!

### What is AsyncAPI?
AsyncAPI offers a standardized approach for describing asynchronous APIs and message-driven systems through YAML or JSON formats. The AsyncAPI specification makes it easier to work with diverse messaging protocols, message structures, and event-driven architectures.

The AsyncAPI document is defined using the AsyncAPI specification, but the document itself doesn't take any direct actions or enforce rules. The real magic of the specification materializes when an AsyncAPI document is implemented using tooling(such as code generators).
TRohit20 marked this conversation as resolved.
Show resolved Hide resolved

Furthermore, the AsyncAPI ecosystem includes tools and code generators designed to take an AsyncAPI definition and automatically generate client and server code in multiple programming languages. Such functionality expedites development while significantly reducing potential errors when handling messages.

### Real-world use cases of AsyncAPI
Eve collaborates with Guild to address their logistics challenge using AsyncAPI. Guild, a global logistics giant operating in multiple countries with varying currencies, faces the complex task of calculating order logistics costs and route optimization for hundreds to thousands of requests, each with varying processing times.

Eve introduces AsyncAPI to Guild, explaining how AsyncAPI can help them share their asynchronous API with clients, validating their incoming messages and more, thereby enabling simultaneous calculations(requests) without waiting for one request to finish before moving on to the next. Multiple requests are processed, and a result (response) is sent to the appropriate user once the calculation is performed.
TRohit20 marked this conversation as resolved.
Show resolved Hide resolved

Having assisted Guild, Eve enjoys her chicken lasagna in her backyard while stargazing. Amidst the stars, she spots what initially seems like Haley's Comet but soon realizes it's something else entirely. To her shock, a spaceship crash-lands in her backyard!
Loading