From the course: Introducing Postman

Unlock the full course today

Join today to access over 22,600 courses taught by industry experts or purchase this course individually.

Document requests

Document requests - Postman Tutorial

From the course: Introducing Postman

Start my 1-month free trial

Document requests

“

- [Instructor] The relationship between work spaces, collections, folders, and requests is about much more than simply organizing and reusing requests. It's really all about communication. Organizing requests in a manner that reflects API usage communicates a lot about the API, but where Postman really shines is in its documentation capabilities. You've likely noticed the description fields scattered across Postman. There are numerous opportunities to provide rich documentation about our collections, folders, and requests by including markdown descriptions. Let's add some notes to the Postman sample API collection. I generally just click the collections ellipses button and then select the edit option to open the edit collections dialogue. When the dialogue opens, you're taken to the description tab, which contains a rather large text area. Here we can describe the collection's purpose. We'll keep our documentation simple but I generally see this as my chance to answer the question…

Contents