AsyncAPI Code Editor

SwaggerHub editor is a split view with the editor on the left and interactive API documentation on the right.

The editor autosaves drafts every 2 minutes, and you can also save your progress manually at any time.

Interactive API docs are generated from your API definition. The API docs are updated automatically as you type, helping you visualize the API you are creating.

To undo any unsaved changes in the editor, use the Revert to Last Saved command.

As you type, SwaggerHub automatically validates your API definition and shows any errors or warnings that might occur, such as syntax errors, unresolved references, or unused definitions. To see the error list, expand the validation bar at the bottom of the editor. Click an error message to jump to the line that triggered this error.

Click the image to enlarge it.

Click the API name in the header area to open the API info panel, where you can fork, delete, rename the API, or transfer it to another user or organization. Note: The available commands depend on whether you are the API owner or collaborator.

On the Integrations tab of the Info panel, you can configure integrations for your API.

At the bottom of the panel, you can see who created this API version and when, who owns the API, and the date and time it was last saved.

If your API has several versions, you can quickly switch between the versions by using the drop-down menu next to the version number.

You can switch between the dark and light syntax highlighting themes. Editor options persist across sessions in your current browser.

The editor’s toolbar also contains the following items:

The SwaggerHub editor supports keyboard shortcuts for faster editing.