Using Markdown for descriptions

Postman supports Markdown as a way to style text descriptions for requests, collections, and folders in collections. You can also embed screenshots and other images for more descriptive flair.

For more information about Markdown, review the reference for using Markdown for API documentation. 

Postman renders Markdown in your Workspace, and in public or internal API documentation.

This topic covers:

• Workspaces
• Public or internal API documentation
• Descriptions for request attributes

Workspaces

In your Workspace, you can use Markdown to style the request description

You can use Markdown to style descriptions for collections and folders.

Public or internal API documentation

Public or internal API documentation can automatically generate API descriptions.

You can use Markdown to style those descriptions.

Descriptions for request attributes

The description column in the data editor makes your requests easier to understand. You can add comments and details for each of your query parameters, path variables, headers, and body (form-data and urlencoded) in the Postman app.

For example, specify if an element is required or optional, indicate the accepted data type, or use alternative terminology to provide additional clarification for developers who work with your requests.

For Postman users who publish internal or public API documentation, these descriptions display in the automatically generated documentation for that collection.

Note: Descriptions for path variables and URL params are currently NOT shown in the documentation.

To hide and show the value and description column in the data editor, click the ellipsis (…) in the top right corner of the editor, and uncheck the columns that you want to hide.

Note: Descriptions are metadata for a request and are NOT sent with your HTTP request. This reminder displays when you mouse over the title of the description column.