- Installation and updates
- Sending the first request
- Creating the first collection
- Navigating Postman
- Keyboard Shortcuts
- Postman account
- New button
- Troubleshooting In-app Issues
- Customizing Postman
- Find and Replace
- Troubleshooting API requests
- Debugging and logs
- Capturing HTTP requests
- Interceptor extension
- Generate code snippets
- Making SOAP requests
- Working with Tabs
- Using GraphQL
- Visualize API responses
- Intro to collections
- Creating collections
- Sharing collections
- Managing collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Commenting on collections
- Version Control for Collections
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to environments and globals
- Manage environments
- Manage globals
- Variables complete reference
- Dynamic Variables List
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Working with data files
- Running multiple iterations
- Building workflows
- Sharing a collection run
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Intro to API documentation
- Viewing documentation
- Local environments and shared environments
- How to document using Markdown
- Publishing public docs
- Adding and verifying custom domains
- Adding team name and logo
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Pricing for monitors
- Troubleshooting monitors
- FAQs for monitors
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Introduction to APIs
- Managing APIs
- Sharing APIs and managing roles
- The API Workflow
- Versioning APIs
- Reporting FAQs
- Viewing and analyzing APIs
- Intro to Workspaces
- Creating Workspaces
- Managing Workspaces
- Using Workspaces
- Sharing collections in Workspaces for version 5
- Activity feed and restoring collections
- What is Postman Pro
- Purchasing Postman Pro
- Billing and pricing
- Upgrading to Postman Pro from a trial team
- Team Settings
- Changing your plan
- Managing your team
- Migrating to Postman v7
- Roles and permissions
- Managing your billing
- Intro to Enterprise
- Purchasing Postman Enterprise
- Running Postman monitors using static IPs
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Audit logs
- Public API documentation
Intro to API documentation
Postman's API Documentation feature lets you view private API documentation or share public API documentation in a beautifully formatted web page.
Postman generates and hosts browser-based API documentation for your collections automatically in real-time. Each collection has a private and public documentation view that Postman generates from synced data in the servers.
To access the private view of your team documentation, go to the sidebar in the Postman app and click the > icon in the collection you want to view. Then click "View in web" to view the documentation for the collection.
To access the private view of your team documentation, go to your workspaces dashboard.
Click the "View all collections" link.
Click a collection name to view the documentation.
After you publish your documentation, you can use the public link to view the documentation.
The public link displays after you publish your documentation. A link to this published documentation is also accessible in the "Published" dropdown from the private documentation view.
You can create documentation in a few different ways:
- Using the New button
- Using the Postman app launch screen following similar steps as the New button
- From an existing collection by viewing the private version of the docs or publishing public docs
Documentation for your API includes:
- Sample requests, headers, and other metadata
- Descriptions associated with requests, folders, and collections
- Generated code snippets in some of the most popular programming languages
- Run in Postman button
Postman uses ordered requests and folders to organize documentation in sections to reflect the structure of your collection.
You can customize descriptions using Markdown styling with embedded graphics to complement your documentation.
Postman supports GitHub-flavored Markdown so you can include tables. When including block elements, make sure you leave an empty line before and after to avoid any rendering issues.
To include helpful cross-references for your readers, you can hyperlink to these parts within the generated documentation:
- Introduction headers
The links are generated using IDs for the requests, folders and responses. If you click on any of these, the URL in your browser should update to a link which points to this specific part of the documentation. You can hyperlink to these parts using this link.
Note: You cannot link to arbitrary parts of the documentation by manually creating an ID.
You can post comments on your API documentation to share information with your colleagues. You can save interactions with your teammates, add information that does not fit anywhere else, and can have discussions and more.
You can post comments on your documentation by navigating to the documentation section from the Postman App. To learn more about accessing the documentation section, see viewing documentation.
Once you access the documentation section, the comments section appears, as shown below:
Click Comments to bring up the 'Add comment' dialog, as illustrated above. Write your comment and click 'Add comment'. Your comment is now posted.
Note: You can post comments only on Private Documentation.