asyncapi/spec

Stars
4,215
Rank 10,259 (Top 0.3 %)
Language
JavaScript
License
Apache License 2.0
Created almost 8 years ago
Updated 3 months ago

asyncapi/spec

asyncapi

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

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

Read the specification

The latest draft specification can be found at spec/asyncapi.md which tracks the latest commit to the master branch in this repository. The human-readable markdown file is the source of truth for the specification.

Looking for the JSON Schema files? Check out our spec-json-schemas repo.

Feel like contributing? Check out our community repo.

Examples

💡 Streetlights

Demonstrates how to use AsyncAPI to define an API that controls city streetlights.

👉 See more

Slack Events API

Partial definition of the Slack Events API. Find the official one here.

👉 See more

Gitter Streaming API

Definition of the Gitter streaming API.

👉 See more

Gemini WebSocket API

Definition of the Gemini Websocket API.

👉 See more

➕ and more...

Check out the examples directory for more examples.

Our Sponsors

Platinum

Gold

Silver

Contributors

Thanks goes to these wonderful people (emoji key):

_{Fran Méndez} 💬 🐛 📝 📖 🤔 🚇 🚧 👀 ✅ 📢	_{Lukasz Gornicki} 📖 🤔 👀 💬 📝 📢 🚧 🚇	_{Mike Ralphson} 💬 📖 🤔 🚇 👀 🚧	_{raisel melian} 💬 🐛 📖 🤔 🚧 👀	_{Chris Wood} 🤔 📖	_{Jonathan Schabowsky} 📖 🤔	_{Victor Romero} 🤔 👀	_{Antonio Garrote} 🤔 👀 📖	_{Jonathan Stoikovitch} 💡 🤔 👀
_{Jonas Lagoni} 🐛 📖 🤔 💬 👀 💡	_{Waleed Ashraf} 📢 🤔 📖 💡	_{Andrzej Jarzyna} 📢	_{Emmelyn Wang} 📝 🤔 📖 📢	_{Marc DiPasquale} 📝 📢 👀 🐛 🤔 📹	_{Gerald Loeffler} 📖 🐛 🤔	_{Dale Lane} 📝 🤔 📹 📢 ✅ 📖	_{Maciej Urbańczyk} 👀 🤔 💬 🐛 📖 💡 🚧	_{Vladimir Gorej} 📖 🐛 💡 🤔 👀
_{Lorna Jane Mitchell} 📢 🤔	_{Laurent Broudoux} 📖 📝 📢 💡 🤔 👀	_{Jesse Menning} 📝 📢 👀 🤔	_{Sergio Moya} 👀 🤔 💬 📝 🐛 📖 💡 🚧	_{Alexander Balogh} 📖 🐛	_{Khuda Dad Nomani} 💡 🐛	_{Aaron Korver} 📖	_{Orlov Valentine} 📖	_{Moez Bouhlel} 📖
_{Muhammad Rafly Andrianza} 📖	_{Daniel Kocot} 📖 💡 🤔	_{sekharbans-ebay} 📖 💡 🤔	_{Michael Davis} 🐛 📖 💡 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!

website

AsyncAPI specification website

modelina

A library for generating typed models based on inputs such as AsyncAPI, OpenAPI, and JSON Schema documents with high customization

cli

CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!

asyncapi-react

React component for rendering documentation from your specification in real-time in the browser. It also provides a WebComponent and bundle for Angular and Vue

studio

Visually design your AsyncAPI files and event-driven architecture.

saunter

Saunter is a code-first AsyncAPI documentation generator for dotnet.

parser-js

AsyncAPI parser for Javascript (browser-compatible too).

community

AsyncAPI community-related stuff.

glee

Glee — The AsyncAPI framework that will make you smile again :)

bindings

AsyncAPI bindings specifications

jasyncapi

/jay-sync-api/ is a Java code-first tool for AsyncAPI specification

java-spring-template

Java Spring template for the AsyncAPI Generator

html-template

HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.

parser-go

It parses AsyncAPI documents.

spec-json-schemas

AsyncAPI schema versions

github-action-for-cli

GitHub Action with generator, validator, converter and others - all in one for your AsyncAPI documents with AsyncAPI CLI as backbone

go-watermill-template

Go template for the AsyncAPI Generator using Watermill module

nodejs-template

This template generates a server using your AsyncAPI document. It supports multiple different protocols, like Kafka or MQTT. It is designed in the way that generated code is a library and with it's API you can start the server, send messages or register a middleware for listening incoming messages. Runtime message validation included.

java-spring-cloud-stream-template

Java Spring Cloud Stream template for the AsyncAPI Generator

avro-schema-parser

An AsyncAPI schema parser for Avro 1.x schemas.

bundler

Combine multiple AsyncAPI specification files into one.

.github

Location of all reusable community health files

vs-asyncapi-preview

VSCode AsyncAPI Preview Extension

server-api

Server API providing official AsyncAPI tools

markdown-template

Markdown template for the AsyncAPI Generator

diff

Diff is a library that compares two AsyncAPI Documents and provides information about the differences by pointing out explicitly information like breaking changes.

python-paho-template

Python Paho template for the AsyncAPI generator

nodejs-ws-template

Node.js WebSockets template for the AsyncAPI Generator. It showcases how from a single AsyncAPI document you can generate a server and a client at the same time.

conference-website

Website for the AsyncAPI online conference

ts-nats-template

Node.js/Typescript template for NATS

converter-go

Convert AsyncAPI documents from older to newer versions with Golang

generator-react-sdk

Generator React SDK enabling the AsyncAPI generator to support React as the rendering engine for templates.

dotnet-nats-template

.NET template for NATS

converter-js

Convert to or migrate between AsyncAPI versions with the converter

template-for-generator-templates

This is a GitHub repository template for generator templates to make it much easier to start writing your own generator template.

simulator

Asynchronous traffic simulation application using async-api

EDAVisualiser

View your system, events, applications through different perspectives

optimizer

AsyncAPI offers many different ways to reuse certain parts of the document like messages or schemas definitions or references to external files, not to even mention the traits. There is a need for a tool that can be plugged into any workflows and optimize documents that are generated from code, but not only.

tck

(WIP) Test Compatibility Suite for AsyncAPI

chatbot

The project's aim is to develop a chatbot that can help people create spec documents without knowing the specification.To get started with, the bot will consume the spec, JSON schema and serves the user as an expert. So based on a set of questions and answers it will generate an AsyncApi spec document according to the use cases.

openapi-schema-parser

An AsyncAPI schema parser for OpenAPI 3.0.x and Swagger 2.x schemas.

extensions-catalog

Catalog of extensions for AsyncAPI specification

shape-up-process

This repo contains pitches and the current cycle bets. More info about the Shape Up process: https://basecamp.com/shapeup

java-template

Java template for the AsyncAPI Generator

jasyncapi-idea-plugin

/jay-sync-api/-idea-plugin is a IDEA plugin for AsyncAPI specification

dotnet-rabbitmq-template

This template is for generating a .NET C# wrapper for the RabbitMQ client based on your AsyncAPI document.

brand

AsyncAPI brand guidelines and strategy

parser-api

Global API definition for all AsyncAPI Parser implementations.

problem

Library that implements the Problem interface. Reference https://www.rfc-editor.org/rfc/rfc7807

php-template

PHP Template for AsyncAPI generator

training

All about trainings, workshops, courses, etc.

raml-dt-schema-parser

AsyncAPI schema parser for RAML data types

enterprise-patterns

Enterprise patterns using AsyncAPI

protobuf-schema-parser

Schema parser for Protobuf compatible with AsyncAPI JS Parser

template-for-go-projects

This is a repository template for golang projects

generator-filters

Library with reusable generator filters that you can use in your templates

generator-hooks

Library with reusable generator hooks that you can use in your templates