- 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 API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing collection runs
- 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
Adding to Postman templates
You can share your documentation for any collection you publish by adding it to the Postman Templates. Adding your templates makes them available to the Postman community through the app via New > Templates and on the web.
Your template listing provides access to the documentation for your API collection, and the Run in Postman button, which allows anyone to import the collection directly into the Postman app. Community members can browse and search for templates to learn, and automate tasks relevant to a wide variety of use cases. People can also access your Postman profile via your template listings.
By publishing your collection docs to the Postman templates, you're sharing both human-readable and executable data that helps people get started using APIs. Your docs can outline how to use a single endpoint as well as how to integrate with an API as a whole, helping community members learn API skills and discover available services.
If you're publishing documentation from a team API, you can add it to the API Network as part of your team listing.
When you add to the Postman templates, your listing will also be discoverable via your profile. You can set your profile up before or during publication, or Postman will generate a profile that you can optionally edit later.
To add to the shared Postman templates, you first need to document and publish a collection. You can share your collection to the Postman templates during the docs publishing process, or later. During publication, enable Collection discovery and select Add to Postman Templates.
If your collection documentation is already published, you can make it discoverable by editing the published docs.
You can access your published docs from the Postman app (select the collection and click View in web), or from the web dashboard (navigate to Workspace > Collections and click the published collection title).
Click Allow Collection Discovery to set up your docs for sharing.
Select Add to Postman Templates.
Enter display details for your template listing, including Template Name, Summary, and Description. Your description will be automatically pulled from any description you have added to your collection already, and should include the information potential users will need to know whether to try the template or not.
Select any relevant categories for your template—users will be able to browse using categories in both the Postman app and on the web.
You can choose to publish your templates under your personal Postman profile, or from a team profile.
Templates published from a team will also appear in the API Network listing Templates tab for the team.
To set up your profile, click Public Profile Settings or navigate to your settings in the web dashboard. Click Enable Public Profile to allow your templates to be published.
You can customize your profile URL and name, and add a description people will see alongside your templates. You can also set a profile photo from your account settings.
If you choose to disable your profile, you won't be able to publish any new templates, and any previously published will be unpublished.
When your publish settings are complete, click Publish Collection. You will see a confirmation of your template listing and public profile.
Your templates will be discoverable from inside the Postman app using New > Templates and on the web.
Your template listing will show the description and publisher details, plus links to the documentation and the Run in Postman button people can use to import the collection and try the requests in the Postman app.
Your profile listing will be available both in the Postman app, and on the web, listing all of your published templates.
Clicking the title of a template will open its listing in the web browser.
Check out some tips for making the most of your listing.