1. Understand your API
- Explore API
- Import API Specification
2. Describe the API
- Create Postman Collection Doc →
- Write API meta data
- Save request examples
3. Get feedback from stakeholders
- Invite teammates to a workspace
- Share collection and API in another workspace Doc →
4. Prepare API for publishing
- Set your logo
- Set color schemes
- Define portal URL
5. Publish your API
- Publish to a URL
- Publish to API Network (optional)
- Publish as a template (optional)
Create comprehensive documentation
Add descriptions to collections, folders, and requests to explain them in detail, outline required variables, and introduce required and optional steps and concepts. Add rich text, deep links, and images with built-in Markdown support.
Document and develop in parallel
Speed up development and ensure accuracy by creating and maintaining documentation along with your collection. That way you can manage your documentation and endpoints in the same place.
Get feedback and collaborate
Share documentation to a team workspace and invite team members to write collaboratively. Stakeholders can also make comments directly on the documentation itself.
Publish with a single click
Once you're ready to share your documentation with the world, just hit publish. You can also preview your docs to make sure they're perfect before publishing.
Maintain a single source of truth
Postman automatically pulls your request and collections descriptions, example responses, code snippets, headers, and other metadata to populate your documentation with dynamic examples and machine-readable instructions.
Update your docs automatically
Never let your documentation lag behind your service again. Postman automatically updates your documentation every time you make changes to your collection—in real-time.
Customize your docs
Publish to a custom domain, add your team logo and change up the colors for a branded developer experience.
Publish to the API Network
Share your API with Postman's 30 million community by publishing your API and documentation on the API Network, a curated list of API publishers.
Add the Run in Postman button for faster onboarding
Add the Run in Postman Button to your documentation or GitHub README so consumers can import the collection and documentation directly into Postman.
What is Postman?
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
A comprehensive set of tools that help accelerate the API Lifecycle—from design, testing, documentation, and mocking to discovery.
Easily store, iterate and collaborate around all your API artifacts on one central platform used across teams.
Organize your API work and collaborate with teammates across your organization or stakeholders across the world.
Improve the quality of APIs with governance rules that ensure APIs are designed, built, tested, and distributed meeting organizational standards.