Postman documentation overview

Collaborate in Postman

Postman provides a variety of tools to enable and enhance collaboration within your team. You can create internal workspaces, where team members can share their work and collaborate on API projects. Users can also discuss their work directly in Postman by commenting on collections and APIs, including on specific requests, versions, and inline on API definitions and scripts.

To learn more about collaboration in Postman, see Collaborate in Postman.

Design and develop your API

Postman supports API-first development with Spec Hub, types in collections, and the API Builder. Use Spec Hub or the API Builder to design your API's structure in an API specification or definition, respectively. Either can act as the single source of truth for your API project. You can also use types in collections to design your API with the Postman Collection format.

To learn more about API-first development, see Design and build your APIs in Postman.

Document your API

Documentation is an important part of any collection or API. Good documentation helps the people who use your collection understand what it does and how each request works. And comprehensive API documentation lets your consumers know what endpoints are available and how to interact with them.

Once you've generated documentation for your collection or API, users can view the documentation in Postman. By default your documentation is private, so you must share a collection or API with others before they can access it. If you're creating a public API, you can publish your documentation to make it publicly available to anyone with a web browser.

To learn more about documenting your API, see Document your APIs in Postman.

Monitor your API

Postman Monitors give you continuous visibility into the health and performance of your APIs. Monitors enable you to run API test scripts, chain together multiple requests, and validate critical API flows. A monitor runs a series of requests from the Postman cloud on a schedule you set. To learn more about using monitors, see Monitor health and performance of your APIs in Postman.

API Governance and API Security

API governance is the practice of defining and applying development rules that promote consistent API behaviors across your organization's API landscape. A robust API security posture means that your organization has development rules that promote security-first API behaviors. The Postman API Governance and Postman API Security features can identify inconsistencies or weaknesses in your APIs, then recommend possible fixes or improvements.

To learn more about Postman's API Governance and API Security features, see API Governance and API Security in Postman.

Administration

Postman provides a variety of options to customize your team's experience, from the initial setup to ongoing team and plan management. As a Team Admin, you can streamline the onboarding process for your team, manage access control, and keep your team up to date with the latest version of Postman.

To learn more about administering your Postman team, see the Team management overview.

Use reports

Postman generates reports that enable you to visualize data for how your team uses Postman. These reports give you insights into the state of your APIs, including tests, documentation, and monitoring coverage. They also enable you to track performance and SLA adherence.

To learn more about how to use reports, see View reports on usage, security, and billing in Postman.

Developer resources

If you're integrating Postman with your CI/CD workflow or are developing with Postman APIs or libraries, check out Postman developer resources.

Integrations

You can connect Postman to your API workflows with integrations for popular third-party solutions. Use integrations to automatically share data between Postman and the other tools you rely on for API development. For more information, see Integrate Postman with third-party solutions.