Code Editor

In editing mode, select Code from the tabs in the upper right. The code editor fills the panel, with syntax highlighting for YAML, JSON or GraphQL SDL. Modify the source directly, then open Preview to inspect the rendered result.

OpenAPI, AsyncAPI and GraphQL all have Code, Diff, Governance and Preview tabs. Only OpenAPI has Form. For a GraphQL schema, Governance is schema validation (syntax errors, unknown types and directives, duplicate names) rather than rule sets. See Supported API Formats.

See AsyncAPI governance for the browser checks and the separate CLI/server release status.

OpenAPI Code Editor

Governance Editor

In editing mode, you can switch to the ‘Governance’ view from the upper right tab. In this view, the left panel shows your current working copy of the spec, which you can change directly, while the right panel displays governance rule checks for this spec. The tab accepts OpenAPI and AsyncAPI documents.

You can switch between rule sets using the dropdown menu to see check results for each set. Clicking on entries in the list will navigate you directly to the corresponding line in the spec, allowing you to easily make changes and fix issues. See Governance While Editing.

OpenAPI Governance Editor

Diff Editor

In editing mode, you can switch to the ‘Diff’ view from the upper right tab. In this view, the left panel shows the contents of the selected spec before your changes, while the right panel displays the current spec with uncommitted changes. You can keep editing in the right panel.

This makes it easy to compare and review what has changed. It’s good practice to use this view before committing your spec changes.

OpenAPI Diff Editor

Preview

Select Preview to see your current edits in the same Redoc 3 renderer used in the repository and published documents. It renders OpenAPI, AsyncAPI and GraphQL. Return to Code to keep editing; the Code tab has no separate preview pane.

OpenAPI rendered with Redoc 3, also used by the editor Preview tab