AsyncAPI Document Type (Framework)
Oxygen XML Editor includes a specialized framework for working with
AsyncAPI
files. The application supports the following AsyncAPI versions: 1.0.0,
1.1.0, 1.2.0, 2.0.0,
2.1.0, 2.2.0, 2.3.0,
2.4.0.
Editing AsyncAPI Documents
You can edit AsyncAPI files in Text mode and you have access to all the usual text editing actions and you can also edit them in the visual Author editing mode and you have access to the various features and actions that are available when editing XML documents in Author mode. When editing AsyncAPI files in Author mode, a + Markdown Syntax Highlight CSS style can be selected from the Styles drop-down menu (available on the toolbar) to make it easier to visualize descriptions with Markdown style syntax highlights.
Default Document Templates
There are some default AsyncAPI templates available when creating new documents from templates and they can be found in the and folders. Each of those folders contain a default new document template for a JSON version and a YAML version. Some other useful examples can be found at public AsyncAPI GitHub project.
Content Completion
Oxygen XML Editor helps you edit AsyncAPI files through the Content Completion Assistant, offering proposals for properties and values that can be inserted at the cursor position. It can be manually activated with the Ctrl + Space shortcut.
Validation
Oxygen XML Editor includes built-in validation for AsyncAPI documents to help you keep them well-formed. The documents are validated automatically as you type against the schema specified in the framework and problems are highlighted within the document.
Resources
- For details about the AsyncAPI Specification, go to https://www.asyncapi.com/docs/reference/specification/v2.0.0.
- Webinar: OpenAPI/AsyncAPI Support in Oxygen