Edit, validate, and test OpenAPI documents
The OpenAPI Specification (OAS) is a standard that describes web APIs in a programming language-agnostic format. It creates a blueprint that explains how software applications communicate over the Internet. Developers use OpenAPI to write instructions in JSON or YAML that describe API details, endpoints, data, and security considerations. This standardized description allows other programs to interact with the API without seeing its internal code.
XMLSpy includes intelligent tools for working with OpenAPI during development or discovery, including validation, editing, and testing.
The graphical JSON Schema Editor in XMLSpy supports validating and editing JSON Schemas based on the OAS. The visual interface makes it easier for developers to work with complex OpenAPI schemas by offering a graphical representation of the structure that makes it easier to understand and to identify errors or inconsistencies.
The JSON Schema editor includes support for OAS extensions including discriminator, xml, format, and external docs that can be configured in the Details entry helper.
Whether your OpenAPI document is written in JSON or YAML, the text-based OpenAPI editor in XMLSpy offers intelligent editing features like syntax highlighting, source folding, auto-completion, and entry helpers.
If you switch to Grid View, XMLSpy provides a graphical representation of the document structure that makes it easier to navigate, understand, and edit. In addition to intelligent editing tools, grid view offers in cell commands, visual drag and drop editing, and table view for rearranging the way nodes are displayed. You can also expand and collapse sections of the data makes to navigate through long files and locate specific elements.
Text and Grid Views both provide validation of documents against the OpenAPI specification.
When starting from scratch, XMLSpy includes built-in templates for creating new OpenAPI documents, with support for Open API 1.0, 2.0, and 3.0.
XMLSpy includes a helpful HTTP Testing Window with support for OpenAPI. The window guides you through the process of creating and sending an HTTP request to an existing API. Then, you can receive, check, and troubleshoot the response directly in the window.
Once you specify the location of the OpenAPI document, the HTTP testing window displays the available paths with their corresponding operations.
Based on the operation and parameters you select to test, XMLSpy autogenerates the test message, which you can send to the API, and then view the results.
The ability to send requests and inspect responses ensures the API behaves as expected during development and integration. It's an effective tool for testing your own APIs as well as exploring third-party interfaces.