Skip to main content

Designing an API

API Studio

API Studio > Design > Designer shows the version's OpenAPI document in a code editor, with a Problems panel beside it. Choose Visual to edit the same document through forms. See Visual designer.

Edit the document​

  1. Open the API and select a draft version.
  2. Open API Studio > Design > Designer.
  3. Choose YAML or JSON above the editor. Switching converts the document. A document with a parse error must be fixed before the format changes.
  4. Edit the document.
  5. Press Save. Save is available when the document has unsaved changes.

After a save, API Studio > Design > Endpoints and API Studio > Design > Schemas show the saved document. A save that the document allows with warnings reports how many there were.

Published versions are read only. Viewers and Auditors see every version read only.

Problems​

The Problems panel checks the document while you type and again after each save. Each problem shows:

  • its severity: Error, Warning, Info or Hint
  • the rule that raised it
  • a message
  • the path in the document, such as paths./orders.get

Select a problem to move the cursor to that place in the editor. No problems found. means the document passed every check.