API Spec Requirements
Superflows accepts the open standard 'OpenAPI Specification' to read API Specifications.
Versions 3.0+ are accepted. If you have a version 2.X OpenAPI specification, you can convert it here.
OpenAPI specifications can be uploaded in .json, .yaml or .txt formats.
We currently don't support allOf, anyOf or oneOf keywords in the OpenAPI specification schemas. If you use these, please contact us.
A common issue is uploading an API spec which references files you have locally.
These local files aren't visible to Superflows when you upload an OpenAPI spec, so you'll need to combine your specification files into 1 file (e.g. using this tool).
About OpenAPI Specifications
OpenAPI Specifications are an open industry standard for defining APIs. A full definition and description can be found on the OpenAPI Initiative website.
The initiatives website describes the specification format as follows:
*The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic.
When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
If you do not use OpenAPI Specifications, please contact us.