Visual Editor for OpenAPI Definitions

API Hub for Design provides Form Editor for OpenAPI 3.0 definitions so that you can update your API information without having to understand the YAML syntax. Form Editor is fully synchronized with the Code Editor. The changes you make in Form Editor are immediately reflected in the YAML code, and vice versa.

Note

If you are using OpenAPI 2.0 version, go to Visual Editor for OpenAPI Definitions Legacy.

Overview

Using Form Editor, you can:

  • Edit OpenAPI information.

  • Edit domains and templates.

  • Sync between form and code view in real-time.

Open Form Editor

To switch to Form Editor, click the Form button in the top bar of the API Hub for Design editor. To go back to the Code View, click the Code button. These two let you switch between Code View and Form Editor easily.

API_screenshot_api_editor_02.png

To see changes you make in real time, click the Preview toggle button.

Important

You cannot switch to Visual Editor if the definition contains YAML errors. Use the Code Editor to fix the errors and then try again.

Got feedback?

You can leave your comments and ask questions in the in-app support chat, or you can send them to:

go.gifhttps://support.smartbear.com/swaggerhub/message/

See Also

Publication date: