How to Reorder Your Examples in Postman Collections


Reading Time: 2 min.

Postman is continuously evolving as an API Platform. As we evolve, we are working towards providing the best documentation tool for knowledge and context transfer within and across team boundaries. Examples are an essential part of the documentation and acts as sample responses to the request. They play a vital role in helping consumers understand the correct data types, formats, required headers, and request body that they can send and the response they would receive when they hit a particular endpoint.

Over the years, we have been working towards making the generation and maintenance of documentation easier and seamless and have built many UI features to make it happen. However, there is a functionality that is currently missing in the collection that does not let users manage examples effectively. It has been one of the most asked improvements from our users, reflected by this GitHub issue.

Today, we are excited to announce that you can re-order examples in the collection sidebar by selecting them and dragging them to their new place, similar to how you can reorder requests and folders. It will help you organize your examples in a way that you like. For example, to improve the readability of documentation generated from the collection, you can choose to put all the ‘success’ responses together followed by errors. It will make it easy for the consumer of the documentation to understand how to interact with the API.

Drag and drop examples to reorder

At Postman, we keep our users at the core of everything that we do and always try to improve the product through the constant feedback we get from the community. It is the love from our users that has helped us grow and reach where we are today. Please try this new improvement and share your feedback.

Vansh Singh is a technical product manager at Postman.

+3

What do you think about this topic? Tell us in a comment below.

Comments

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.

You might also like: