Descriptions for request attributes in Postman

Postman is introducing a new description column in the data editor making your requests easier to understand. You can now add comments and details for each of your query parameters, path variables, headers, and body (form-data and urlencoded) – all from right within 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 are working with your requests.

One step closer to comprehensive API documentation

For Postman Pro users publishing internal or public API documentation, these descriptions are displayed in the automatically generated documentation for that collection.

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

You can hide and show the value and description column in the data editor by clicking on the ellipsis (…) in the top right corner of the editor, and unchecking the columns that you want to hide.

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

13 thoughts on “Descriptions for request attributes in Postman”

    1. Hi Andrew, there is no ETA on this, but we’re working on this currently. Please stay tuned for latest updates!

      1. We are trying to document our API with Postman and because you don’t show path variables and URL params in the documentation, this process is a real pain.

  1. what is a necessary function is the team comments. The tester should have some way to leave comments on a team collection and notify the developer.

    1. Hi Zhuoran,
      Thanks for the suggestion! I agree – comments are a useful feature to have in a collaborative environment, and is a part of our long term roadmap. I’ve added this as a feature request anyway 🙂

  2. Any plans to add line-by-line descriptions for the body? The most complicated requests we see usually have complex objects in the body of the text, not just in the parameters.

  3. Hi Postman team,

    thanks for your hard work- I love what you have done so far. However, rendering path variables and URL params is a must. We are currently working around that problem with Markdown, but it is a really slow and painful process. Could you please provide an ETA?

  4. Is Path Variables supported for documentation? Because in Node we are having problem creating a documentation for path variable .

  5. For our documentation I was wondering if their is a way to tell that certain params are REQUIRED and what the DEFAULT value is if the user doesn’t add this parameter to the request

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.