From 939fc74bdaf499aca344c16dfe22f90f268ac573 Mon Sep 17 00:00:00 2001 From: kakabisht Date: Tue, 28 Nov 2023 18:52:10 +0530 Subject: [PATCH 01/12] intial draft for module 5 --- 100-level-AsyncAPI-Intro/step5.md | 39 +++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 100-level-AsyncAPI-Intro/step5.md diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md new file mode 100644 index 0000000..0df50ca --- /dev/null +++ b/100-level-AsyncAPI-Intro/step5.md @@ -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. + +Building on the basics, module two transitions into understanding Event-driven Architecture(EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. + +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 + +There are different creative tools in your AsyncAPI toolkit: + +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. +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. +- [AsyncAPI YouTube Tutorials](https://www.youtube.com/c/AsyncAPI): AsyncAPI YouTube - Access video tutorials covering various aspects of AsyncAPI, enhancing your learning experience. From b48cfc406e2dacebf8672e06dfb370d40559f954 Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Sat, 2 Dec 2023 16:04:06 +0530 Subject: [PATCH 02/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Alejandra Quetzalli --- 100-level-AsyncAPI-Intro/step5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 0df50ca..623ac73 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -23,7 +23,7 @@ The fourth module focuses on hands-on experience by learning to write AsyncAPI c 1. Utilize AsyncAPI tools to validate the created documents. 1. Engage in hands-on exercises to reinforce your understanding and skills. -## AsyncAPI toolkit +## AsyncAPI tools There are different creative tools in your AsyncAPI toolkit: From ad1faff9f49a141c885af66e6c08b8c50de7d055 Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Sat, 2 Dec 2023 16:06:31 +0530 Subject: [PATCH 03/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Alejandra Quetzalli --- 100-level-AsyncAPI-Intro/step5.md | 1 - 1 file changed, 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 623ac73..eae5ade 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -25,7 +25,6 @@ The fourth module focuses on hands-on experience by learning to write AsyncAPI c ## AsyncAPI tools -There are different creative tools in your AsyncAPI toolkit: 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. From c6a8f99d6e73b88e38ba685e120a83d955cdfef8 Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Sat, 2 Dec 2023 16:06:40 +0530 Subject: [PATCH 04/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Alejandra Quetzalli --- 100-level-AsyncAPI-Intro/step5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index eae5ade..eda48e7 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -35,4 +35,4 @@ AsyncAPI Studio helps you draw your API plans, the CLI checks if everything's in - [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. -- [AsyncAPI YouTube Tutorials](https://www.youtube.com/c/AsyncAPI): AsyncAPI YouTube - Access video tutorials covering various aspects of AsyncAPI, enhancing your learning experience. +- [AsyncAPI YouTube](https://www.youtube.com/c/AsyncAPI): Watch AsyncAPI community meetings and learning content on our YouTube channel. From fa8ada03353eb13ec89b925f0377cde18b6b3bba Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Sat, 2 Dec 2023 16:06:52 +0530 Subject: [PATCH 05/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Alejandra Quetzalli --- 100-level-AsyncAPI-Intro/step5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index eda48e7..897a522 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -34,5 +34,5 @@ AsyncAPI Studio helps you draw your API plans, the CLI checks if everything's in ## 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. +- [AsyncAPI GitHub Repository](https://github.com/asyncapi#-join-asyncapi-community): AsyncAPI GitHub README - Join the AsyncAPI community and start contributing. - [AsyncAPI YouTube](https://www.youtube.com/c/AsyncAPI): Watch AsyncAPI community meetings and learning content on our YouTube channel. From ac22a7695423a9147617324e6a3648bafe630bd7 Mon Sep 17 00:00:00 2001 From: kakabisht07 Date: Mon, 22 Jan 2024 13:02:26 -0500 Subject: [PATCH 06/12] fixing base issue --- 100-level-AsyncAPI-Intro/step5.md | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 897a522..62a13da 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -6,33 +6,15 @@ The third module explores the AsyncAPI specifications. You learn about the struc 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 tools +AsyncAPI Studio helps you design and create a blueprint for your asynchronous API. For example, drawing a map displaying how to exchange messages between two teams. -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. + 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#-join-asyncapi-community): AsyncAPI GitHub README - Join the AsyncAPI community and start contributing. -- [AsyncAPI YouTube](https://www.youtube.com/c/AsyncAPI): Watch AsyncAPI community meetings and learning content on our YouTube channel. +* [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#-join-asyncapi-community): AsyncAPI GitHub README - Join the AsyncAPI community and start contributing. \ No newline at end of file From 32a2115b14e16124da6e23db5ae3fb2cd3ad3cc3 Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Thu, 25 Jan 2024 12:19:40 -0500 Subject: [PATCH 07/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Quetzalli --- 100-level-AsyncAPI-Intro/step5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 62a13da..96639e2 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -1,6 +1,6 @@ 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. -Building on the basics, module two transitions into understanding Event-driven Architecture(EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. +Building on the basics, module two transitions into understanding Event-driven Architecture (EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. 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. From 69d2455274a99219e9d0c868bfa4c7ae47a79c76 Mon Sep 17 00:00:00 2001 From: kakabisht07 Date: Thu, 25 Jan 2024 12:21:38 -0500 Subject: [PATCH 08/12] Fix typos --- 100-level-AsyncAPI-Intro/step5.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 62a13da..bdf4cb4 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -1,4 +1,4 @@ -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. +In this learning journey, you explore AsyncAPI, a powerful tool for crafting asynchronous APIs. The first module discusses what AsyncAPI is and why to use AsyncAPI and explores real-world use cases where AsyncAPI is a valuable asset. Building on the basics, module two transitions into understanding Event-driven Architecture(EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. @@ -10,7 +10,7 @@ The fourth module focuses on hands-on experience by learning to write AsyncAPI c AsyncAPI Studio helps you design and create a blueprint for your asynchronous API. For example, drawing a map displaying how to exchange messages between two teams. -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. +AsyncAPI CLI (Command-Line Interface) helps you run AsyncAPI using text commands in a terminal. For example, you type “Bake the cake” in the AsyncAPI CLI, and the AsyncAPI CLI bakes a cake for you. 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. From e2ed228541a9f8491597373d5b8a2076666a38da Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Mon, 29 Jan 2024 18:48:16 -0800 Subject: [PATCH 09/12] tw editorial fixes --- 100-level-AsyncAPI-Intro/step5.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 28c638c..4b52744 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -1,20 +1,20 @@ -In this learning journey, you explore AsyncAPI, a powerful tool for crafting asynchronous APIs. The first module discusses what AsyncAPI is and why to use AsyncAPI and explores real-world use cases where AsyncAPI is a valuable asset. +In this intergalactic journey, you explored AsyncAPI, a powerful specification for crafting asynchronous APIs. The first module discusses what AsyncAPI is and why to use AsyncAPI, exploring real-world AsyncAPI use cases. Building on the basics, module two transitions into understanding Event-driven Architecture (EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. -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 third module explores the AsyncAPI specification. 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 the request/reply pattern. -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. +The fourth module focuses on hands-on experience with exercises for writing AsyncAPI code and documents from scratch. It also introduces AsyncAPI Studio for validating your documents. ## AsyncAPI tools +Ready to explore more of the AsyncAPI world? Check out the AsyncAPI tool ecosystem! -AsyncAPI Studio helps you design and create a blueprint for your asynchronous API. For example, drawing a map displaying how to exchange messages between two teams. - -AsyncAPI CLI (Command-Line Interface) helps you run AsyncAPI using text commands in a terminal. For example, you type “Bake the cake” in the AsyncAPI CLI, and the AsyncAPI CLI bakes a cake for you. - -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 design and create a blueprint for your asynchronous API. +- AsyncAPI CLI (Command-Line Interface) helps you run AsyncAPI using text commands in a terminal. +- AsyncAPI Generator helps you plan and build the initial structure of your project. +- And more! ## 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#-join-asyncapi-community): AsyncAPI GitHub README - Join the AsyncAPI community and start contributing. \ No newline at end of file +* [AsyncAPI Documentation](https://www.asyncapi.com/docs/): The official documentation provides comprehensive examples and context for learning AsyncAPI. +* [AsyncAPI GitHub Repository](https://github.com/asyncapi#-join-asyncapi-community): Join the AsyncAPI community and start contributing. \ No newline at end of file From 7f278d5bb3f35fcaa87cb5fd52c95637e850c59a Mon Sep 17 00:00:00 2001 From: hridyesh bisht <41201308+kakabisht@users.noreply.github.com> Date: Tue, 20 Feb 2024 12:43:24 -0500 Subject: [PATCH 10/12] Update 100-level-AsyncAPI-Intro/step5.md Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> --- 100-level-AsyncAPI-Intro/step5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 4b52744..0f05f7d 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -17,4 +17,4 @@ Ready to explore more of the AsyncAPI world? Check out the AsyncAPI tool ecosyst ## Extra resources * [AsyncAPI Documentation](https://www.asyncapi.com/docs/): The official documentation provides comprehensive examples and context for learning AsyncAPI. -* [AsyncAPI GitHub Repository](https://github.com/asyncapi#-join-asyncapi-community): Join the AsyncAPI community and start contributing. \ No newline at end of file +* [AsyncAPI Community GitHub Repository](https://github.com/asyncapi#-join-asyncapi-community): Join the AsyncAPI community and start contributing. \ No newline at end of file From cdfb635ff343c396361f8aeb10d7b79e7a3067b4 Mon Sep 17 00:00:00 2001 From: kakabisht07 Date: Tue, 20 Feb 2024 12:52:15 -0500 Subject: [PATCH 11/12] partial feedback --- 100-level-AsyncAPI-Intro/step5.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index 28c638c..5171281 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -2,8 +2,8 @@ In this learning journey, you explore AsyncAPI, a powerful tool for crafting asy Building on the basics, module two transitions into understanding Event-driven Architecture (EDA), showcasing how AsyncAPI fuels the design of both EDA and microservices. -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 third module explores the AsyncAPI specifications. You learn about the structure of AsyncAPI and its different components, such as info, channels, operations, and messages. You also learn to implement the request/reply pattern. + 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. ## AsyncAPI tools From cbb112e4b5d2ee4e91e4edb837f5427b31090e66 Mon Sep 17 00:00:00 2001 From: kakabisht07 Date: Mon, 26 Feb 2024 12:55:09 -0500 Subject: [PATCH 12/12] adding hyperlinks --- 100-level-AsyncAPI-Intro/step5.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/100-level-AsyncAPI-Intro/step5.md b/100-level-AsyncAPI-Intro/step5.md index e8e5571..f0f6cc9 100644 --- a/100-level-AsyncAPI-Intro/step5.md +++ b/100-level-AsyncAPI-Intro/step5.md @@ -9,9 +9,9 @@ The fourth module focuses on hands-on experience with exercises for writing Asyn ## AsyncAPI tools Ready to explore more of the AsyncAPI world? Check out the AsyncAPI tool ecosystem! -- AsyncAPI Studio helps you design and create a blueprint for your asynchronous API. -- AsyncAPI CLI (Command-Line Interface) helps you run AsyncAPI using text commands in a terminal. -- AsyncAPI Generator helps you plan and build the initial structure of your project. +- [AsyncAPI Studio](https://github.com/asyncapi/studio) helps you design and create a blueprint for your asynchronous API. +- [AsyncAPI CLI](https://github.com/asyncapi/cli) helps you run AsyncAPI using text commands in a terminal. +- [AsyncAPI Generator](https://github.com/asyncapi/generator) helps you plan and build the initial structure of your project. - And more! ## Extra resources