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: content for module 5 #8

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
39 changes: 39 additions & 0 deletions 100-level-AsyncAPI-Intro/step5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
In this learning journey, you explore Async API, a powerful tool for crafting asynchronous APIs. The first module discusses what AsyncAPI is and why to use Async API and explores real-world use cases where AsyncAPI is a valuable asset.
kakabisht marked this conversation as resolved.
Show resolved Hide resolved

Building on the basics, module two transitions into understanding Event-driven Architecture(EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices.
kakabisht marked this conversation as resolved.
Show resolved Hide resolved

The third module explores the AsyncAPI specifications. You learn about the structure of AsyncAPI and its different components, such as info, channels, components, and tags. You also learn to define operations, messages, and schemas and grasp the request/reply patterns within AsyncAPI.

The fourth module focuses on hands-on experience by learning to write AsyncAPI code and documents from scratch. The module also introduces tools to validate these documents and practical exercises to solidify your learning.

1. Introduction to AsyncAPI:
1. Explore the fundamentals of AsyncAPI.
1. Understand the reasons for using AsyncAPI.
1. Discover real-world use cases demonstrating the practical applications of AsyncAPI.
1. Event-Driven Architectures:
1. Dive into the concept of event-driven architectures.
1. Learn how AsyncAPI can be a powerful tool in designing Event-driven systems
1. Understand the role of AsyncAPI in crafting APIs for microservices.
1. AsyncAPI Specification:
1. Grasp the structure of an AsyncAPI document.
1. Explore various components such as info, channels, components, and tags.
1. Learn to define operations, messages, and schemas, including the request/reply pattern.
1. Creating and Validating AsyncAPI Code and Documents:
1. Gain practical skills in writing AsyncAPI code and documents from scratch.
1. Utilize AsyncAPI tools to validate the created documents.
1. Engage in hands-on exercises to reinforce your understanding and skills.

## AsyncAPI toolkit
kakabisht marked this conversation as resolved.
Show resolved Hide resolved

There are different creative tools in your AsyncAPI toolkit:
kakabisht marked this conversation as resolved.
Show resolved Hide resolved

AsyncAPI Studio helps you design and create a blueprint for your asynchronous API. For example, you are planning a birthday party and drawing a map displaying how messages move from one friend to another.
Async CLI (Command-Line Interface) helps you run AsyncAPI using text commands in a terminal. For example, you type “Bake the cake” in the AsyncCLI, and the CLI bakes a cake for you.
kakabisht marked this conversation as resolved.
Show resolved Hide resolved
Generator helps you plan and build the initial structure of your project. For example, It's like having an assistant who sets up the starting point of your birthday party.
AsyncAPI Studio helps you draw your API plans, the CLI checks if everything's in order, and the Generator magically creates the starting point for your projects.

## Extra resources

- [AsyncAPI Documentation](https://www.asyncapi.com/docs/): The official documentation provides comprehensive information, examples, and guides for understanding and using AsyncAPI.
- [AsyncAPI GitHub Repository](https://github.com/asyncapi/asyncapi): AsyncAPI GitHub - Explore the AsyncAPI GitHub repository for code samples, issues, and community contributions.
kakabisht marked this conversation as resolved.
Show resolved Hide resolved
- [AsyncAPI YouTube Tutorials](https://www.youtube.com/c/AsyncAPI): AsyncAPI YouTube - Access video tutorials covering various aspects of AsyncAPI, enhancing your learning experience.
kakabisht marked this conversation as resolved.
Show resolved Hide resolved