Skip to main content

Import and export

API Studio

API Studio reads and writes these formats, as JSON or YAML:

  • OpenAPI 3.0, 3.1 and 3.2
  • Swagger 2.0
  • Postman 2.1

Import a document​

From the API Studio page, Import creates a new API from the document. From an API, Import replaces the document in the selected draft. Import needs the Builder, Admin or Owner role, and appears on drafts only.

  1. Press Import.
  2. For a new API, enter a Name.
  3. Choose a File (.json, .yaml or .yml), or paste the document into Document.
  4. Press Import.

A document in another format is converted when it is imported. When the conversion has warnings, the dialog lists them with the source format before you press Done. Each warning shows a code, a message and the place in the document it refers to.

Export a version​

  1. Open the API and select the version.
  2. Press Export.
  3. Choose the Target: OpenAPI 3.1, OpenAPI 3.2, OpenAPI 3.0, Swagger 2.0 or Postman 2.1.
  4. Choose JSON or YAML.
  5. Press Download. The file downloads.

When a target cannot hold everything in the document, the dialog lists the warnings and stays open until you press Done.