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
21 changes: 21 additions & 0 deletions 100-level-AsyncAPI-Intro/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Eve, a programming genius with a knack for solving diverse problems and helping others' lives at Optimists Lane 7, Capuccinova.

It's 6 a.m. on a Monday, and pleasant Lofi music goes off, waking her up.

After getting ready and making her coffee, glancing at the clock showed her running late for her first work meeting with Adeo. Adeo is one of the users of AsyncAPI, the organisation that Eve works at as an Open-source contributor!
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

### What is AsyncAPI?
AsyncAPI provides a standard way to describe asynchronous APIs and message-driven systems using YAML or JSON format, making it easier for developers to understand and work with different messaging protocols, message formats, and event-driven architectures.
AsyncAPI specification can be defined using an AsyncAPI document, but the document alone will not do or enforce anything. The specification does the magic only when an AsyncAPI document is implemented or instantiated.
There are many tools and code generators that can take an AsyncAPI definition and automatically generate client and server code in various programming languages, saving time and reducing the potential for errors in message handling.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

### Real-world use cases of AsyncAPI
Eve works with Adeo to understand their problem and how AsyncAPI can help them solve it.

Adeo explains their problem to Eve: Adeo is a massive logistics company spread across an entire planet consisting of various countries and currencies. As a logistics company worldwide, Adeo faces the challenge of calculating the logistics cost of a particular order from multiple sources and the difference in cost from order to order. They constantly run calculations to check which route is more cost-efficient or which yields them more profit per order. That could be 100s or 1000s of requests that need to be processed, each being processed at varying times, meaning one request would take 1 minute while another request might take 5 minutes.

Eve walks them through how AsyncAPI can help them by processing the requests asynchronously, meaning the calculations(requests) will be processed simultaneously without waiting for one request to complete before calculating another. This way, multiple requests are processed, and a result(response) is sent to the appropriate user/person once the calculation is performed.

After helping Adeo with their problem, Eve moves on with her day. She serves herself with some chicken lasagna and sits down in her backyard to enjoy her meal as she watches the stars.

Watching the stars, Eve notices what appears to be Haley's comment. But, she quickly realises it is not, as what seems to be a spaceship crash lands in her backyard.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved