What is OpenAPI?
Table of Contents
What is OpenAPI?
OpenAPI is an industry standard for describing web APIs in a computer-readable way.
Globus services all provide APIs, and OpenAPI is the way by which those APIs can be documented.
"Registered APIs" refer to service APIs that have been registered with the Globus Flows service so that an API can be used by a flow.
The Globus Flows service currently supports OpenAPI 3.1. Older versions, including OpenAPI 3.0, are not supported.
How do I get an OpenAPI specification document?
Many popular web frameworks are able to generate OpenAPI specification documents automatically, or via plugins.
For example, FastAPI, a popular Python web framework, automatically generates OpenAPI specification documents. Others, like Django and Flask, may require a plugin to generate OpenAPI specifications.