AsyncAPI AsyncAPI Conference 2021, 16 Nov 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: AsyncAPI Hackathon Summary and Presentation. Souvik De, Hackathon winner with his AsyncAPI Bundler

Description

AsyncAPI Conference 2021 - Day 1
16th November 2021

A

Hi I'm shovik and I am a cs undergrad from india, I'm in my final year of college and I also maintain async api clm.

A

I found async api during gsoc. I was looking for open source project to contribute to, and I stumbled upon, async app initiative in the process of making application for gsoc. I spent a lot of time with the code base. I learned about event, ribbon architecture and got involved in the community, and at that time I was pushing code to cli on a regular basis, because I was having my holiday at the time and after, like two months, uh lucas asked me to join nursing kpi as a maintainer of cra.

A

So I was like super happy and after that, yeah that's pretty much. What I've been doing now- and this is my first open source project that I'm maintaining and I'm super excited and the community is super, helpful and friendly. So the overall experience is awesome.

A

uh This is async api's first hackathon and I really wanted to be a part of it. I wanted to build something that would improve the existing tooling for the community.

A

After researching a bit and talking to lucas, I found out that the use cases robotics had and there was no tooling yet uh the supported by sync api. So I thought maybe we could build something around that. So that's why I built a single api and I like to give you a walkthrough of my whole project. So let's go.

A

So the project I built in this hackathon is a sink api bundler and just as the name suggests, it bundles multiple async api files into one. For now you can use bundler for two main use cases.

A

A single bundler can help you specif help you. If your specification file looks something like this, where there are references to external files, having this structure is beneficial as your specification files are well divided and you can reuse them effectively.

A

Also, your specification files are quite less in size, but the problem arises while transporting these files, as the specification file depends on other files to resolve misplacing and transporting them will break your spec file.

A

Also, now generator allows you to load spec files or internet, but having a structure like this, you cannot use this functionality. This is where async api bundler comes to rescue. It resolves all the external references. Let me show you how it's done.

A

So here is a specification file. You can see it has references, so it depends on this file to resolve right. So.

A

Asynctp bundler also has a cli, so you can just call it from your cli. Let me show you.

A

It just needs the path of the file to load right.

A

So, let's see so this is the combined specification that it prints out. If you want to generate a new file, all you do is pass in a file name and let's say it is naming it combine.yml.

A

So the file is now generated and, as you can see, there is no references in this file. It has resolved all the references accordingly so going to the next use case.

A

So the second use case was inspired from zura robotics, where they were using async api to document their distributed system. So what happens? Every service has their own spec file, which is helpful when you care only about one specific service.

A

But when you want to work with the whole system, it would benefit to have a single specification file. This is what async epa bundler is aiming to solve by letting you combine your complete specification files. Okay. So before you start with the example I would like to like, there are some points to consider all specification files should be valid and complete.

A

What I mean by this is each individual specification file should follow async, bpa specification, 2.0 and latest, and it should be able to be passed by the parser and, secondly, no two documents should define same channel or schema properties. Okay, so now, moving on to the, for example,.

A

If you look at this specification file, it is a complete spec file that has that defines two channels. Okay, so now these two channels should be unique to this file. Firstly, second, this is this is defining.

A

Documentation for audio interface: this is another file which is defining documentation for camera interface right. So now we'll combine these two specific files and combine them into one. So, let's.

A

A

We need to pass both the specification files as a parameters, so first.

A

So I'm going to pass this base dot by ml as a base file. So what it's basically doing is telling the telling bundler to override all these properties, so after merging these properties will be overridden, so you can pass a base file which have custom properties that is not present in any other files or you can also change some properties.

A

So this is how you do it there and also pass in this file output file, name.

A

A

So, as you can see,.

A

This is the file that was generated right now and it has been see. The title has been replaced from the base yml, and you can see that the server's server property was added from the basement as well here and.

A

The components are merged, see and also all the channels are here as well.

A

So this is what bundler does.

A

You can also use a single bundler as a library, and it also so you can basically write your own scripts to manage how the sync different rcap, spec files will be merged. As of now.

A

There are some configurations currently supported.

A

Before every specification file is merged, it is first validated, so you can also change this behavior by passing, validate files as an option. Also, if you're using a different schema, you can pass in a custom. Parser schema as well.

A

So next is the future of the project.

A

As of now, the project is under my github account. I would like to bring this project under async api org and maintain it further.

A

We might also add this feature in async power, suggest itself and then add support to our cli. I don't know how we are going to go ahead with this, but you can see these features soon in async, api tooling, so for some features that I'll be working next.

A

Currently, I think api bundler does not support circular references, so that is something I will be working on next and secondly, uh this is something experimental instead of resolving external refs, we'll just merge the data and reference internally, so the generated file will have references, but they will not point to any external source.

A

And thank you- and this is a sim kpi bundler in a nutshell, and thanks for joining the conference, see ya.