Home
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Developer
AsyncAPI Document Type (Framework)
A project used to describe and document message-driven APIs in a machine-readable format

Introduction
Welcome to the User Manual of Oxygen XML Developer 26.1
Getting Started
Information and resources to help you get started using Oxygen XML Developer as quickly as possible
Installation
The requirements and installation instructions for each platform
Configuration
Description of all of the options that allow you to configure Oxygen XML Developer
Perspectives
The Editor, XSLT Debugger, XQuery Debugger, and Database perspectives
Editing Modes
The Text, Grid, , and Schema Design editing modes
Working With Documents
General information about features available when working with documents
Editing Supported Document Types
Details about the various types of supported documents and their unique editing features
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Developer
- DocBook 4 Document Type (Framework)
  A document type standard for books, articles, and other prose documents (particularly technical documentation)
- DocBook 5 Document Type (Framework)
  An enhanced (version 5) document type standard designed for a variety of documents (particularly technical documentation)
- DocBook Assembly (5.1 and Later)
  A document type standard used to define the hierarchy and relationships for a collection of DocBook resources
- DocBook Topic (5.1 and Later)
  A document type standard used as a modular unit of DocBook documentation
- DocBook Targetset Document Type (Framework)
  A document type standard used to resolve cross references with the DocBook olink
- DITA Topics Document Type (Framework)
  An XML-based architecture designed for authoring, publishing, and delivering technical information
- DITA Map Document Type (Framework)
  A document type that collects and organizes references to DITA topics or other maps
- XHTML Document Type (Framework)
  Extensible HyperText Markup Language includes the same depth of expression as HTML, but also conforms to XML syntax
- TEI P5 Document Type (Framework)
  A standard for the academic community that collectively defines an XML format for text that is primarily semantic rather than presentational
- TEI ODD Document Type (Framework)
  An XML-conformant specification that allows you to create TEI P5 schema in a literate programming style
- jTEI Document Type (Framework)
  A highly restrictive customization (only about 80 elements are included) of the TEI P5 standard
- JATS Document Type (Framework)
  A technical standard that defines an XML format for scientific literature
- EPUB Document Type (Framework)
  An e-book file format that is a ZIP archive and can be downloaded and read on devices such as phones, tablets, computers, or e-readers
- OpenAPI (Swagger) Document Type (Framework)
  A specification that defines a standard programming language-agnostic interface description for HTTP APIs
- OpenAPI Test Scenario Document Type (Framework)
  A framework that provides the ability to inspect OpenAPI request responses and to ensure that they work as expected
- AsyncAPI Document Type (Framework)
  A project used to describe and document message-driven APIs in a machine-readable format
- JSON-LD Document Type (Framework)
  An easy-to-use lightweight Linked Data format that consists of multi-dimensional arrays
Additional XML Editing Frameworks (Document Types)
The custom frameworks that are supported in Oxygen XML Developer
Publishing
Details about transformation scenarios and customizing various types of output
Working with XPath Expressions
Information about using XPath Expressions in Oxygen XML Developer
Working with Archives
Describes how to use the Archive Browser to work with various type of archives
Databases and SharePoint
Connecting to supported databases and integrating Oxygen XML Developer with SharePoint
Importing Data
Information about how to import data from external sources into XML documents
XSLT/XQuery Debugging
The debugging interface that detects problems with XSLT and XQuery transformations
Extending Oxygen With the SDK
Information about extending Oxygen XML Developer using the SDK
Add-ons
Information about extending Oxygen XML Developer with add-ons
Tools
Specifics about the various tools that are included in Oxygen XML Developer
Troubleshooting
A compilation of common problems and their solutions
Scripting Oxygen
Details about the scripting possibilities that are available with Oxygen XML Developer
Glossary
Copyright
Legal information

AsyncAPI Document Type (Framework)

Oxygen XML Developer 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.

Default Document Templates

There are some default AsyncAPI templates available when creating new documents from templates and they can be found in the Framework Templates > AsyncAPI 1.x and Framework Templates > AsyncAPI 2.x 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 Developer 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 Developer 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