Document your APIs from the Postman VS Code extension

Postman automatically generates basic documentation for any collection you create, including details about requests and sample code in various client languages.

Write documentation

Teammates with the Editor role can add descriptions to collections, folders, and requests to make more valuable information available to your users. 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:

1. Click Collections, then select a collection or folder.
2. Enter a description in the Overview tab.
3. Click outside of the editor to save your description.

To add a description to a request, do the following:

1. Click Collections, then select a request.
2. Click View Documentation in the upper right.
3. Enter a description in the right sidebar.
4. Click outside of the editor to save your description.

To learn more about writing documentation, see Write documentation in Postman.

View documentation

You can view complete documentation for your collection that includes a description of each request and details such as the method and URL, the required authorization type, 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:

1. Click Collections, then select a collection.
2. In the Overview tab, click View complete documentation. The VS Code extension opens the complete documentation in a new tab.

You can customize the appearance of the documentation by selecting a language to use for sample code.