Postman API design

Postman brings design, testing, documentation, and monitoring into a single workspace, so developers can move fast and teams can enforce standards with built-in governance.

Postmanaut using robotics to design A P I. Illustration.

API Design Example in Postman.

Define your APIs

Define the contract of your API by creating a new specification or importing existing ones using Spec Hub

Create

Design new API specifications in OpenAPI 3.0 or AsyncAPI 2.0 formats, streamlining API creation

Import

Import existing API specifications in popular formats (Open API 1.0/2.0/3.0, RAML 0.8/1.0, GraphQL)

Generate

Automatically generate collections from your API schemas and specifications, with types in collections enabled for detailed request definitions

Sync

Maintain bi-directional synchronization between your API specifications in Spec Hub and your GitHub repository, ensuring consistency across development environments

Validate

Validate your API elements against your API schema


Supported schema formats

OpenAPI

Postman supports the latest OpenAPI specification as well as Swagger 1.0/2.0.

RAML

The RESTful API Modeling Language (RAML) has become a popular choice for designing APIs.

GraphQL

Postman allows you to author and send GraphQL queries using the request body.


Postman's Client Interface. Diagram.

Develop your APIs

Generate comprehensive API documentation directly from your schemas and API collections, ensuring accuracy and consistency.

Mock servers

Create mock servers to kick start development faster.

Documentation

Write API documentation or generate it from schema

Environment

Store variables for all your different development environment

Sharing

Share your APIs with other members of your team

Postman's Client Interface. Diagram.

Test your APIs

Add test suites, integration tests, and contract tests to your APIs

Test suites

Link collections, enriched with types, in your workspace as test suites to an API using version tagging

Test integrations

Add integration tests to check if your endpoints work as expected with other APIs and services

Test contracts

Write contract tests to ensure that your APIs are working according to their specification

Learn more about continuous testing of APIs →

Postman's Client Interface. Diagram.

Observe your APIs

Monitor, report, and analyze how your APIs are performing

Monitor

Connect monitors in your workspaces with APIs.

Report

Collect and review API reports under a single view in the Postman web dashboard.

Analyze

Understand API performance, collection executions, test failures and team-level metrics.


Get started today

Join the millions of developers who are already developing their APIs faster and better with Postman.

Download the App
POST/CON 2024 Banner

June 3 & 4, 2025 in Los Angeles, CA

Step into the future of APIs and AI at POST/CON 25. Join developers, architects, and tech leaders to build smarter, faster, and more secure APIs in the age of generative AI.

Loading...