Skip to main content

Reference docs

API Studio

API Studio > Design > Docs shows the reference docs for the selected version, rendered from its saved document. Save changes in API Studio > Design > Designer to see them here.

Read the docs​

  1. Open the API and select a version.
  2. Open API Studio > Design > Docs.

The docs list each operation with its parameters, request body, responses and schemas. Use the search box and the side menu to move between operations.

Download a version​

Downloads lists each export format with a JSON and a YAML button:

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

Press a button to download the version in that format. When a format cannot hold part of the document, the parts that were simplified are listed under Downloads.

For the same downloads from the API page, see Import and export.