View live documentation for your API specification

Postman displays a live preview of your API’s documentation if you’re editing an OpenAPI or AsyncAPI specification. The documentation preview is updated as you edit the specification. You can use the preview to help you visualize your changes as you work.

As you edit an OpenAPI specification with multiple files and folders, a live preview also displays for your the root and non-root files.

To show the documentation preview, click Live preview in the right sidebar.

You can view live documentation for the following types of sections:

• OpenAPI — The live preview displays documentation for Info, Servers, and Paths sections of your specification. Live preview also displays documentation for the Schemas, Responses, and Request Bodies components in the Components (OpenAPI 3.0 and 3.1) and Definitions (OpenAPI 2.0) sections. The preview doesn’t display documentation for other sections such as Security.
• AsyncAPI 2.0 — The live preview displays documentation for the Info, Servers, and Channels sections of your specification. The preview doesn’t display documentation for other sections.