- Installation and updates
- Sending your first request
- Navigating Postman
- New button
- Creating the first collection
- Postman account
- Keyboard Shortcuts
- Troubleshooting In-app Issues
- Authorizing requests
- Working with Tabs
- Visualize API responses
- Validating Requests Against Schema
- Generate code snippets
- Using GraphQL
- Making SOAP requests
- Capturing HTTP requests
- Debugging and logs
- Troubleshooting API requests
- Intro to collections
- Creating collections
- Sharing collections
- Commenting on collections
- Managing collections
- Version Control for Collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing a collection run
- Working with data files
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Authoring your documentation
- Publishing your docs
- Viewing documentation
- Custom documentation domains
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- FAQs for monitors
- Intro to Workspaces
- Creating Workspaces
- Using Workspaces
- Managing Workspaces
- Viewing changelogs and restoring collections
- The API Workflow
- Managing and Sharing APIs
- Versioning APIs
- Viewing and analyzing APIs
- Validating Elements Against Schema
- Customizing Postman
- Find and Replace
- Purchasing Postman
- 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
- Intro to Integrations
- Custom Webhooks
- Microsoft Flow
- Microsoft Teams
- Publishing API documentation
Publishing your docs
You can publish your API documentation to make it available for public viewing by anyone who has the link. Published documentation allows anyone who wants to learn how to use your API to view detail on endpoints, including parameters, request and response bodies, and example code.
Your public documentation will always display up-to-date content representing the current state of your collection. You don’t need to repeat the publication flow each time you want to update your documentation.
You can publish documentation for collections that you created or have permission to edit.
- Sharing your public docs
- Publishing and unpublishing
- Next steps
You can publish docs from an existing private documentation page or from the collection in the Postman app.
To publish from your collection's private documentation in the web browser, select a version and click Publish.
To publish from the collection in the Postman app, select the collection in Collections, open the actions menu (...), and choose Publish Docs.
Any confidential information in your environment, such as passwords and access tokens may become publicly visible when you publish your docs. Remove all sensitive information from the environment before you publish.
In the Publish Collection page, you can configure how you want your public docs to appear.
- Select a collection version to publish.
- Select an environment to populate variables in your published documentation.
You can preview your documentation before publishing it.
With Postman Team, Business, or Enterprise, you can opt to use a custom domain for your public documentation site.
You can configure the style of your public docs by selecting colors for the top bar, sidebar, and highlights. Try making changes and preview to see how your docs will appear when published.
You can customize the style of your public docs by adding a team name and logo via your team settings if you have admin access. Your logo will replace the Postman logo in your team's published docs—updated logo images may take a few minutes to appear.
To share your API documentation with your users and the wider Postman community, enable Collection discovery by toggling the switch.
- Choose Add to API Network to feature your docs in the Postman publisher network.
- Choose Add to Postman Templates to share your collection with the Postman community and make it discoverable via the app.
You can only add to API Network when publishing from a team. You can configure your team profile by clicking Public Profile Settings, enabling your profile, and filling out your team details for display.
Your team profile can include a name, description, custom URL, and logo.
Add listing details for your public documentation, including name, summary, description, and relevant tags.
If you do not want to make your docs discoverable at this time, you can go ahead and publish then add them to the API Network or Postman Templates later.
Once you have your publish settings complete, click Publish Collection to make your docs public.
You will see a confirmation that your docs are public together with a link you can share.
You can unpublish your docs at any time by clicking Unpublish.