Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 1.04 KB

README.md

File metadata and controls

15 lines (8 loc) · 1.04 KB

Examples

In this directory, you can find some examples of AsyncAPI documents.

Do you have an example that could be valuable? Open a pull request to contribute it.

File naming

You may notice asyncapi in the the name of each example. We recommend doing the same with your AsyncAPI document. This way you enable features like documentation display on node hover, auto completion and validation of your AsyncAPI documents in IDEs like VSCode or IntelliJ IDEA. IDEs integrate with SchemaStore where AsyncAPI specification JSON Schema files are referenced. Some IDEs do it by default, some, like VSCode require you to install additional extensions, like YAML extension.

Editors

To edit your AsyncAPI documents, you can use AsyncAPI Studio.

If you prefer to use your favourite IDE, there are official extensions for VSCode and IntelliJ IDEA