When you create a collection, Postman automatically generates basic documentation that includes details about requests and sample code in various client languages. Using the built-in editor, you can add a description, include links, and add images and videos. By including documentation in your collections, it provides more context and detail, making it more useful to users.
Write documentation
Teammates with the Editor role can add descriptions to collections, folders, and requests. You can write your descriptions using the visual editor or you can enter Markdown syntax.
To add a description to a collection or folder, do the following:
- Click
Collections, then select a collection or folder. - Enter a description in the Overview tab.
- Click outside the editor to save your description.
To add a description to a request, do the following:
- Click Collections, then select a request.
- Click
View Documentation in the upper right. - Enter a description.
- Click outside the editor to save your description.
To learn more about writing documentation, see Write documentation in Postman.
View documentation
You can view a collection’s complete documentation that includes each request’s description. Documentation also includes details such as the request’s method and URL, authorization, and any headers or parameters. For each request, you can view sample code in various client languages, and example response bodies and headers.
To view the complete documentation for a collection, do the following:
- Click Collections, then select a collection.
- In the Overview tab, click View complete documentation. The Postman VS Code extension opens the complete documentation in a new tab.
You can also customize the language used in the collection’s sample code. In the complete documentation view, click the Language tab, then select a language from the list. The documentation updates each request with the selected language.