An AsyncAPI Example: Building Your First Event-driven API

• spec

  14 3,514 0.0 JavaScript

  The AsyncAPI specification allows you to create machine-readable definitions of your asynchronous APIs. (by asyncapi)

  

  However, in order for the system to work effectively, there must be a common understanding between the components regarding events and their data structures. This is where AsyncAPI comes in; it helps define a contract that describes how the components communicate and behave effectively.

• cli

  3 26 7.1 TypeScript

  Bump.sh CLI - Deploy your OpenAPI & AsyncAPI documentations from your CI (by bump-sh)

  

  You can then proceed to upload your AsyncAPI file manually or using Bump.sh CLI.

• Onboard AI

  getonboard.dev

  sponsored

  Learn any GitHub repo in 59 seconds. Onboard AI learns any GitHub repo in minutes and lets you chat with it to locate functionality, understand different parts, and generate new code. Use it for free at www.getonboard.dev.

  

• mosquitto

  16 7,920 0.0 C

  Eclipse Mosquitto - An open source MQTT broker

  

  Optional: Mosquitto, an open-source message broker that implements the MQTT protocol; this tutorial uses the public test server

• git

  139 7,872 9.9 C

  A fork of Git containing Windows-specific patches. (by git-for-windows)

  

  Git

• github-action

  2 38 0.0 TypeScript

  GitHub action to deploy your API documentation on Bump (by bump-sh)

  

  Let’s walk through the process of implementing an event-driven API using AsyncAPI, a specification for defining asynchronous APIs. We’ll also introduce Bump.sh, a tool for documenting and tracking event-driven APIs lifecycle/changes, and demonstrate how you can use it in conjunction with AsyncAPI files.

• InfluxDB

  www.influxdata.com

  sponsored

  Collect and Analyze Billions of Data Points in Real Time. Manage all types of time series data in a single, purpose-built database. Run at any scale in any environment in the cloud, on-premises, or at the edge.

  

Suggest a related project