OpenAPI
Swagger is a suite of tools for API developers from SmartBear Software. It was also formerly the name of a specification from which the OpenAPI Specification evolved.
On this page
Source content checked . English translation published 2026-10-27.
In business automation
OpenAPI describes in a document what can be called in an API: paths, fields, and errors. In automation, this document is the basis for building a connection and running checks, and helps avoid guessing field names.
Examples
These examples illustrate a possible workflow. Adapt the connections and rules to your own systems.
Build a connection from a specification, not trial and error
A provider publishes an OpenAPI file. The team generates test requests from it and sees which required fields are missing. The process is connected to the live environment only after the specification matches the actual response.
Relevant tools
- n8n
- An OpenAPI description can be imported to build requests. Still, check a live response against the specification before going to production.
What to check
- An outdated or incomplete specification can cause a connection to fail when a field added on the server is undocumented.