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

Blog: Mastering Event-Driven Architectures - Why Solace Event Portal is Your AsyncAPI Ally #3514

Open
gvensan opened this issue Dec 23, 2024 · 0 comments

Comments

@gvensan
Copy link

gvensan commented Dec 23, 2024

Post title

Mastering Event-Driven Architectures - Why Solace Event Portal is Your AsyncAPI Ally

Post description

Event-driven architectures (EDA) have become a cornerstone of modern software systems, enabling organizations to build responsive, scalable, and loosely coupled applications. At the heart of these architectures lies the need for clear, precise communication between services, often represented by AsyncAPI documents.

To generate AsyncAPI documents, we have following options:

Hand Coding - Many teams still manually write AsyncAPI documents in YAML/JSON, especially smaller teams or projects with simple requirements.
Code-First Tools - Tools like the AsyncAPI Generator and SDKs (e.g., Java, Node.js libraries) enable teams to generate AsyncAPI documents from existing codebases.
Design-First Platforms - Tools and Platforms that provide graphical interfaces to design events visually. These tools generate AsyncAPI documents automatically, reducing manual effort.

This blog focuses on tools that support a design-first approach to building event-driven applications and APIs, especially in generating AsyncAPI documents. While tools like Stoplight Studio and AsyncAPI Studio are valuable, there's potential for a more engaging experience that brings in visualization, discovery and collaboration into the play.

Guide

Here are a few steps you can follow to write an AsyncAPI blog post:

  1. After getting feedback on the issue, fork the website repository or open it in Gitpod. You can do that by prefixing the issue URL with gitpod.io/#.
  2. Run the command npm run write:blog.
  3. Run the website by using instructions from the README to test your changes.
  4. Open a PR with your blog post and test your changes with a preview of the site on Netlify. If you use Gitpod, it will create a fork of the website repo for you before you create a PR.
  5. Maintainers reviewing the article (e.g., language, images) may ask for improvements.
  6. Once it's merged, it will be available live in production. 🚀

We encourage you to write a blog post and share it with the community. We can't wait to read it 😄!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant