Run a full API workflow from the terminal with the Postman CLI. Starting from a template repo you fork, you lint an OpenAPI spec, build a collection and environment, run a mock, and push it all to a Postman workspace.
- You'll build
- A GitHub repo with a linted spec, collection, environment, and mock, synced to a Postman workspace.
- Time
- About 35 min · 3 parts · 8 steps · progress saves as you go
- How it works
- You do each step in Postman, then click Validate. LiftOff checks your workspace and marks the step complete.
- You'll need
- A free Postman account and API key (connect it below)
- A few setup steps, shown below before you start
Connect a Postman API key to check your work
You do each step in Postman, then LiftOff uses your key to look at your workspace and confirm it's done. Connect once and it works for every module. Your key is saved in this browser and is only used to check your work in Postman.
Before you start
Everything in this module happens in a terminal, and you never need the Postman desktop app. You'll need:
- The Postman CLI (v1.70 or later, so the
mock,workspaceandspec ai-readinesscommands are available). - A Postman API key.
- Git and a GitHub account. You'll fork a template repo, and the GitHub CLI (
gh) makes that quicker.