Edit online

OpenAPI Test Scenario Document Type (Framework)

Oxygen XML Developer includes a specialized framework for working with OpenAPI test scenario files. It includes the usual text editing actions, a visual editing interface, content completion, and automatic validation.

Default Document Template

There is a default scenario file template available when creating new documents from templates and they can be found in the Framework Templates > OpenAPI Test Scenario.

Content Completion

Oxygen XML Developer helps you edit OpenAPI test scenario 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 OpenAPI test scenario 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.

OpenAPI Tools

The following additional OpenAPI tools are available as free add-ons:
  • OpenAPI Tester - Provides the ability to inspect OpenAPI request responses and to ensure that they work as expected. It can be used for OpenAPI 3.x in JSON or YAML format. For details, see OpenAPI Tester Add-on.
  • Run OpenAPI Test Scenario - Provides the ability to run a test suite for an OpenAPI document in JSON format. It performs the requests based on the specified OpenAPI document and the data entered in the test file, and then checks if the server responses are as expected. For details, see Run OpenAPI Test Scenario.
  • OpenAPI Documentation Generator - Provides the ability to generate documentation for OpenAPI components in HTML format, including annotations and cross references. The documentation displays information about the servers, paths, components and tags defined in the OpenAPI 3.0 documents and it is presented in a visual diagram style with various sections, hyperlinks, and filtering options. For details, see OpenAPI Documentation Generator Add-on.

Resources