AsyncAPI: Enhanced Preview Option with Markdown and MermaidJS Diagrams

[AceTheCreator]

This project proposes the development of an alternative preview option for visualizing message payloads using Markdown and MermaidJS Class Diagrams. The envisioned feature aims to integrate seamlessly with the existing AsyncAPI schema and Avro (.avsc) files, providing a dynamic and interactive representation of message structures.

Additionally, the preview should support synchronization between the preview panel and source code, allowing users to navigate and comprehend the structure effortlessly. The project includes a crucial export functionality to enhance usability, enabling users to export the Markdown preview as text for easy inclusion in external documentation. This endeavor combines the power of Markdown and MermaidJS to offer a comprehensive and visually appealing preview option, fostering a more intuitive understanding of message payloads within the AsyncAPI ecosystem.

Learn more here https://github.com/asyncapi/vs-asyncapi-preview/issues/161

Mentor/s: @ivangsa

Project Repo: https://github.com/asyncapi/vs-asyncapi-preview

Expected Difficulty: Easy-Medium

Expected Time Commitment: 175 Hour

[fmvilas]

Nice! Do we have @ivangsa in already?

[AmBha21]

Hi @fmvilas and @AceTheCreator,

My name is Amol and I am a student studying CS. I was interested in this project because often times I have trouble writing scripts/programs because of a lack of understanding of the payloads for certain APIs. Therefore, anything that would help bring clarity to a developer (like me) makes the project exciting to work on.

I've noticed that on projects or lengthy tasks assigned, I've been able to perform best if I have weekly meetings with an expert so I can get guidance. Additionally, I've always found it helpful to have the contact info of someone in case I need to ask a question about a blocker. Having those two things really helps me accomplish my objectives.

During the project, I will be doing some preparation for classes after the end of the summer and practicing my violin. Those two things will take some time throughout the day.

As for work preferences/staying organized, I really like to keep it simple and use a calendar app, such as iCal, and the Reminders app on the iPhone. Those two tools have really helped me during school and research projects so that I'm always prepped for upcoming events.

Aside from the introduction guidelines I found here, I just wanted to say I've used the Postman app a decent bit during the past summer and really enjoyed it. It was a fun and easy way to test if my APIs were working correctly. I really think I'd like working on Postman to enhance the product's features!

Let me know if you have any questions/concerns for me!

[maverox]

Hello @fmvilas and @AceTheCreator,

I'm Uzair, a CS student, intrigued by this project for its potential to clarify API payloads. I have used postman a lot in my journey of learning development for testing API(s) and was really fascinated about how it works.

Outside of the project, I'll be dedicating time in the drama soc of my college as i am an active member there as well writing composing the music for our street plays, but particularly the load is supposedly lesser of this commitment during the internship period so hopefully it won't be a hinderance.

Feel free to reach out if you have any questions or concerns!

[EmmanuelSibi]

Hi @AceTheCreator and @fmvilas,

I am Emmanuel , currently a Computer Science undergraduate student. I am interested in this project because I have also faced difficulties while trying to locate a specific item or data from a complex API response and I believe this project will provide easier understanding of a complex API response by providing clear visual diagrams of message payloads, making complex nested structures and their relationships easier to grasp.

You can the best out of me by providing crisp and regular communication, by offering challenging tasks, by giving some learning resources and last but not least recognition and feedback.

During the tenure of this project, I do not plan to engage in any other academic or professional endeavors.

My work preferences are basically being organised by using version control like git and also maintaining a clean code with proper comments so that when I come back later i know what's going on quickly.

Should you have any further inquiries, please feel free to reach out.

[Inkithai]

Dear @AceTheCreator and @fmvilas ,

My name is Inkithai Meiyalagan, 4th year CS student. I have completed my SE intersnhip I am excited to express my interest in contributing to the AsyncAPI project titled "Enhanced Preview Option with Markdown and MermaidJS Diagrams" for Google Summer of Code 2024.

Having reviewed the project description and repository, I am particularly drawn to this project due to its potential to enhance the clarity and understanding of API payloads through dynamic visualization. As a computer science student, I have often encountered challenges in comprehending complex API responses, and I believe that developing a feature like this would greatly benefit developers like myself.

I have noted the expected difficulty level (Easy-Medium) and the estimated time commitment (175 hours), and I am fully prepared to dedicate myself to this project.

In terms of my approach to the project, I have found that regular communication and guidance from experienced mentors significantly enhance my productivity and understanding. Therefore, I would greatly appreciate the opportunity to have weekly meetings with you or another expert mentor to receive guidance and address any challenges that may arise. Furthermore, having a direct point of contact for questions or blockers would be immensely helpful in ensuring smooth progress throughout the project duration. I am fully committed to dedicating my time and effort to this project to deliver the best possible outcomes.

Regarding my work preferences and organizational tools, I prefer to keep things simple and efficient. I rely on version control systems like Git for code management and utilize calendar apps such as iCal for scheduling tasks and reminders. These tools have proven effective in keeping me organized and on track during previous academic and research projects.

In conclusion, I am enthusiastic about the opportunity to contribute to the AsyncAPI project and collaborate with you and the rest of the team to bring the enhanced preview option to fruition. I am confident that my skills, dedication, and commitment to excellence make me a suitable candidate for this project.

Thank you for considering my proposal. I look forward to the possibility of working together and contributing to the success of this project. Please let me know if there are any additional requirements or next steps in the application process.