API Development Overview

Postman supports API-first development with the API Builder. You can design your API directly in Postman using the API Builder. Your specification can then act as the single source of truth for your API project.

You can connect various components of your API development and testing process to your schema, such as collections, documentation, tests, mocks, and monitors. You can version your APIs in Postman and connect elements to specific versions and releases. You can also sync your API in Postman with a remote Git repo.

High-level steps

The following are the high-level steps involved when creating and using APIs:

Open APIs from the left sidebar in Postman. You can open and edit any existing APIs from here, or create or import new APIs. Select a parent entry to open the API's Overview page, or select a child entry underneath to open an API version page.

API Builder left sidebar

The API Overview page displays high-level information about all versions of your API, and a list of each version of the API. The Overview page includes actions to create a new version of the API.

API Builder overview page

Select an API version to open its API version page. The version page contains an Overview tab, which shows a description of the API version, a list of each release of that version, and the associated documentation, environments, and mock servers. The API version page also has has tabs where you define the API schema, view documentation, add tests, view deployments, and monitor the API. This page also has controls to connect to and use an external Git repo.

API Builder version page

There's a also right sidebar with several icons, depending on the current page open. For example, on the API version page, there are icons to view comments, generate boilerplate server code from your schema, and view the API's changelog. From the changelog, you can also view and create new releases.

API Builder version page

Last modified: 2022/01/21