Postman displays a live preview of your API's documentation if you're editing an OpenAPI 3.0 or AysncAPI 2.0 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.
To show the documentation preview, select Live preview in the right sidebar. Select
Close to hide the documentation preview.
You can view live documentation for the following types of sections:
Info
, Servers
, and Paths
sections of your specification. Live preview also shows documentation for the following Components
sections: Schemas
, Responses
, and Request Bodies
. The preview doesn't show documentation for other sections such as Security
.Info
, Servers
, and Channels
sections of your specification. The preview doesn't show documentation for other sections such as Components
.Last modified: 2025/03/17