Design your API in Postman using the API Builder

Postman supports API-first development with the API Builder. You can use the API Builder to design your API in Postman before developing it. Your API definition can then act as the single source of truth for your API project.

With the API Builder, you can connect various Postman elements of your API development lifecycle to your API definition, such as collections, documentation, and tests. You can also integrate your API in Postman with a Git repository, such as GitHub, GitLab, Bitbucket, or Azure DevOps.

The maximum number of API objects you can create in the API Builder is determined by your Postman plan. Learn more about what's included with each plan.

Designing and developing your API

The following are the high-level steps involved when designing and developing your APIs in Postman:

To view and work with APIs, select APIs in the sidebar. From here, you can open and edit any existing APIs, or create or import new APIs. Use the arrows to expand an API in the sidebar and view the API's definition files and linked elements.

API Builder sidebar

When you select an API in the sidebar, the workbench displays an overview of the API. The overview displays a description of the API, tags associated with the API (Enterprise plans), any linked collections, and the API's published versions. The overview also provides quick access to tasks, such as connecting to a Git repository, adding tests, observing API performance, and viewing deployments.

API Builder overview

The right sidebar offers more options for working with your API. You can view comments, generate server code from your API definition, and view the API's changelog.

API Builder changelog

For APIs connected to a Git repository, the changelog is replaced by the Source Control pane, which you can use to sync your changes with a remote Git repository.

Last modified: 2024/01/18