Video 4 - draft script

[Barbanio]

Description

• This is a draft script for AsyncAPI of the fourth educational and technological video.

Related issue(s)
See also #155

[alequetzalli]

AsyncAPI and OpenAPI comparison (draft 1)

As you can see, you'll find lots of similarities between OpenAPI and AsyncAPI!

In event-driven architectures, you have more than one protocol, and therefore, some things are different. Let's check out the following comparison chart, inspired by Darrel Miller's blog post:

[Barbanio]

I like the idea. Like this, the differences and similarities of each initiative are very clear. Do you think we should describe verbally what appears in the image?

[alequetzalli]

I can see how that could be useful! I vote yes... do you want me to help add this myself? (I am not sure I would get it 100% technically correct either, I will have to ask for another techy review.)

@Barbanio

[Barbanio]

@alequetzalli, yes, I need technical help with this. I can't quite understand how it works exactly. That makes me feel a bit unsure when writing about these kinds of things.

[alequetzalli]

Ok, let me add something and then tag Lukasz when I'm done because I'm not sure I will get it right either 🤣

I will tag you again here once I add my first attempt 😄

[alequetzalli]

AsyncAPI and OpenAPI comparison (draft 2)

As you can see, you'll find lots of similarities between OpenAPI and AsyncAPI!

In event-driven architectures, you have more than one protocol, and therefore, some things are different. Let's check out the following comparison chart, partially inspired by Darrel Miller's blog post:

As we look at these diagrams, we see how AsyncAPI uses servers for configuring their hosts and security, while OpenAPI mentions only hosts and security handled separately. Moving on, AsyncAPI has channels with messages that include headers and payload information. OpenAPI, however, has paths for making REST API calls. Lastly, notice how both AsyncAPI and OpenAPI have components. In fact, both AsyncAPI and OpenAPI have a Parameters component in common, but the rest of their components are completely different.

---

Ok, how about something like that, @Barbanio? 🤔 💭

We will still need someone like @derberg or @smoya to review my proposal here and confirm if it's technically acurate. 😄 👍🏻

[alequetzalli]

@derberg / @smoya / etc.. the section enclosed by the blue 🟦 is what needs technical review

[derberg]

left some comments for improvement

[derberg]

this sentence suggests that I should see a kind of similarities, but I see screen shot from landing pages of both initiatives, is it intended? Maybe we should use some of the images from @jessemenning in this video -> https://www.asyncapi.com/blog/openapi-vs-asyncapi-burning-questions

[dameeolawuyi]

I believe it will help to briefly discuss the style(REST, message-driven) employed by these two API types so it wouldn't seem strange when a reference is made to them later in the script.
not sure I'm technically correct to refer to them as style though.

[derberg]

I do agree that REST, basically synchronous communication should be addressed here,

you can reuse some stuff from video 2, just as short explanation

this is how it is done here, and it is good, clears out what open API is and in short says what REST is

[derberg]

I mean pizza store, where in video 2 there will be pizza store with broker showing async, then briefly in this video we can use it as intro,

• like watch video 3 to learn what AsyncAPI is, but basically to summarize it is for describing asynchronous communication -> show pizza store
• and to understand its difference with OpenAPI you first need to know OpenAPI was designed for synchronous communication -> show pizza store what happens when you remove broker and force people to talk to each other directly, every few minutes (cook asking waiter if there is new order, every minute + waiter asking cook if order is ready every minute) - so basically complete chaos 😄
• these are completed 2 different architectures that require different specifications and this is main difference between openapi and asyncapi, but yeah lets jump into details

---

thoughts?

[Barbanio]

@dameeolawuyi, thank you very much for your great feedback ✨

[derberg]

I do agree that REST, basically synchronous communication should be addressed here,

you can reuse some stuff from video 2, just as short explanation

this is how it is done here, and it is good, clears out what open API is and in short says what REST is

[derberg]

I mean pizza store, where in video 2 there will be pizza store with broker showing async, then briefly in this video we can use it as intro,

• like watch video 3 to learn what AsyncAPI is, but basically to summarize it is for describing asynchronous communication -> show pizza store
• and to understand its difference with OpenAPI you first need to know OpenAPI was designed for synchronous communication -> show pizza store what happens when you remove broker and force people to talk to each other directly, every few minutes (cook asking waiter if there is new order, every minute + waiter asking cook if order is ready every minute) - so basically complete chaos 😄
• these are completed 2 different architectures that require different specifications and this is main difference between openapi and asyncapi, but yeah lets jump into details

---

thoughts?

[Barbanio]

Hi! I have created the animations that could be included in this video. An example of EDA and REST architecture to compare AsyncAPI and Open API. And a small animation to explain the protocols section. You can see all this here: https://drive.google.com/drive/folders/1bs34-ut6pmBbBh_wj5D1w5YMHyHYXdiZ?usp=sharing. Thoughts?