asyncapi-generator

The AsyncAPI generator. It can generate documentation, code, anything!


Keywords
asyncapi, documentation, generator, markdown, codegen, codegenerator, get-global-docs-autoupdate, get-global-node-release-workflows, get-global-releaserc, hacktoberfest, nodejs
License
Apache-2.0
Install
npm install asyncapi-generator@0.33.0

Documentation

AsyncAPI Generator

npm npm

โš ๏ธ This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the AsyncAPI converter. If you need to convert documents on the fly, you may use the Node.js or Go converters.

Overview

Generator is a tool that you can use to generate whatever you want basing on the AsyncAPI specification file as an input. For more information read the docs.

There is a large number of templates that are ready to use and are officially supported by the AsyncAPI Initiative.

List of official generator templates

Template Name Description Source code
@asyncapi/nodejs-template Generates Nodejs service that uses Hermes package click here
@asyncapi/nodejs-ws-template Generates Nodejs service that supports WebSockets protocol only click here
@asyncapi/java-template Generates Java JMS application click here
@asyncapi/java-spring-template Generates Java Spring service click here
@asyncapi/java-spring-cloud-stream-template Generates Java Spring Cloud Stream service click here
@asyncapi/python-paho-template Generates Python service that uses Paho library click here
@asyncapi/html-template Generates HTML documentation site click here
@asyncapi/markdown-template Generates documentation in Markdown file click here
@asyncapi/ts-nats-template Generates TypeScript NATS client click here
@asyncapi/go-watermill-template Generates Go client using Watermill click here
@asyncapi/dotnet-nats-template Generates .NET C# client using NATS click here
@asyncapi/php-template Generates PHP client using RabbitMQ click here
@asyncapi/dotnet-rabbitmq-template Generates .NET C# client using RabbitMQ click here

You can find above templates and the ones provided by the community in this list

Contributing

Read CONTRIBUTING guide.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

Fran Mรฉndez
Fran Mรฉndez

๐Ÿ’ฌ ๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿšง ๐Ÿ”Œ ๐Ÿ‘€ โš ๏ธ โœ…
Jonas Lagoni
Jonas Lagoni

๐Ÿ’ฌ ๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿ”Œ ๐Ÿ‘€ โš ๏ธ
Lukasz Gornicki
Lukasz Gornicki

๐Ÿ’ฌ ๐Ÿ› ๐Ÿ“ ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿšง ๐Ÿ”Œ ๐Ÿ‘€ โš ๏ธ โœ… ๐Ÿš‡
Travis Reeder
Travis Reeder

๐Ÿš‡ ๐Ÿ“–
Semen
Semen

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿ”Œ ๐Ÿ‘€ โš ๏ธ
Waleed Ashraf
Waleed Ashraf

๐Ÿ’ป ๐Ÿ›
Sebastiรกn
Sebastiรกn

๐Ÿ’ป
Derk Muenchhausen
Derk Muenchhausen

๐Ÿ’ป
Ben Timby
Ben Timby

๐Ÿ’ป
Amanda  Shafack
Amanda Shafack

๐Ÿ“–
Florence Njeri
Florence Njeri

๐Ÿ“– ๐Ÿ‘€ ๐Ÿš‡ ๐Ÿšง
Pratik Haldankar
Pratik Haldankar

๐Ÿ“– ๐Ÿ‘€ ๐Ÿšง ๐Ÿ“ข
swastik suvam singh
swastik suvam singh

๐Ÿ’ป
GavinZhengOI
GavinZhengOI

๐Ÿ“–
lmgyuan
lmgyuan

๐Ÿ“–

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