View live documentation for your API specification

This page is for Postman Docs, version Latest (v12) (default). For other versions, use one of these documentation indexes: - Latest (v12) (default): https://learning.postman.com/latest-v-12/llms.txt - v11: https://learning.postman.com/v11/llms.txt

Postman displays a live preview of your API’s documentation if you’re editing an OpenAPI, AsyncAPI, or Smithy 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.

The preview shows documentation for the part of the specification where your cursor is. For example, put your cursor in an operation to preview that operation’s documentation. If you put your cursor on a $ref, the preview shows documentation for the referenced item.

As you edit an OpenAPI specification with multiple files and folders, a live preview also displays for the root and non-root files. If a non-root file isn’t referenced from the root file, the preview only displays if the file is a valid JSON schema.

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

If your specification has errors, the preview displays a warning that the documentation may not be up to date. Click errors in the warning to go to the first error in your specification.

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, Request Bodies, and Path Items (OpenAPI 3.1) 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 — The live preview displays documentation for the Info, Servers, Channels, and Operations (AsyncAPI 3.0) sections of your specification. Live preview also displays documentation for Messages components. The preview doesn’t display documentation for other sections.
• Smithy — The live preview displays documentation for the specification overview and for services, operations, resources, and shapes.