Collection

A machine readable artifact that acts as a container for storing and organizing multiple API requests, providing an executable, self-documented reference for a complete API, a subset of an API, as well as workflows containing multiple requests from across many different APIs in a specific order, with a precise business function.

Does this provide what you need? Let us know by submitting issue!

Postman collections are a fundamental executable unit of value describing an API or collection of APIs intended to accomplish a specific business purposes. Collections resemble OpenAPI often times in how they are used, but diverge when it comes to being able to derive different documentation, mocks, tests, and complete or subsets of an API, providing a machine readable representation, but also one that can be executed as part of different lifecycle processes. Collections can contain many different API requests that can be organized by folders, possessing all the technical details of each API request, but also contains authorization, scripts, and other useful elements. Collections are the heartbeat of the Postman API platform, and begin with helping save requests defined while using Postman as an API client, but can also be applied to almost every stop along the API lifecycle when producing APIs, and speed up integration and automation for API consumers. Collections are extremely versatile, and represent a low-code vision of what is possible when it comes to working with APIs.



Actions


Related Elements

  • Request - An individual request being made to an API, possessing all of the technical details to make the request, including URL, authorization, headers, body, and even scripting to apply business logic before a request is being made to any API.
  • Authentication - The consistent application of standard authentication as part of a standardized API management layer striking a balance between access to digital resources but ensuring that undesirable actors do not have access to valuable assets.
  • Scripts - Lightweight scripts that can be run as part of each API request, providing pre-request scripting, or post-request scripting that help appy business logic at either end of the request, helping transform, test, and automate with each API request.

Related Links


Blueprints

Return to Main Page

This provides a link back to the home page if you need it.