- Installation and updates
- Sending your 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
- Authorizing requests
- Capturing HTTP requests
- Generate code snippets
- Making SOAP requests
- Working with Tabs
- Using GraphQL
- Visualize API responses
- Intro to collections
- Creating collections
- Sharing collections
- Managing collections
- Requesting access
- 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 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
- Documenting your API
- Viewing documentation
- Authoring your documentation
- Publishing your docs
- Custom documentation domains
- 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
- Validating Elements Against Schema
- Versioning APIs
- Reporting FAQs
- Viewing and analyzing APIs
- Intro to Workspaces
- Creating Workspaces
- Managing Workspaces
- Using Workspaces
- Sharing collections in Workspaces for version 5
- Viewing changelogs and restoring collections
- What is Postman Pro
- Purchasing Postman Pro
- Upgrading to Postman Pro from a trial team
- Team Settings
- Changing your plan
- Managing your team
- Migrating to Postman v7
- Roles and permissions
- 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
- Publishing API documentation
Authoring your documentation
You can include information in your API documentation using Markdown. Postman will populate various parts of your documentation from the information associated with the relevant collection. Your Markdown content can include standard structures and formatting such as headings, lists, images, links, bold / emphasis, code samples, blockquotes, and tables.
- Documenting with descriptions
- Describing collections
- Using examples in your docs
- Documentation links
- Using images in docs
- Markdown demo collection
- Next steps
You can add descriptions to various places within your collections and requests, and they will appear in your documentation. You can include descriptions for collections, requests, parameters, and headers.
You can include Markdown descriptions in your documentation, for collections and the requests within them.
You can add a description when you create a collection, or by selecting the collection and using the arrow button (▶).
When you include block elements, leave an empty line before and after to avoid any rendering issues.
You can provide a description when you create a new request or for an existing request at any time.
When you create a new request using the New button, you will be prompted to provide a name and description (which can include Markdown), both of which will appear in your documentation.
To add a description to an existing request, open the request in Postman and edit the request detail.
Descriptions will appear in the request section in your documentation.
You can add a description to the parameters and headers in your requests—for people viewing the request inside Postman (for example if you're working on a shared collection), or for anyone viewing your documentation.
The description will appear in your docs, in the request Params and Headers sections, next to the parameter or header name.
You can include example request and response data in your collections, and they will appear in your documentation.
Any body data included in your request will appear in the endpoint section of your documentation.
You can also create an example to use for a request.
Any data you include in the example will appear in the docs example code sidebar, including body and response data.
Don't see your language of choice, or is there a setting missing that you'd find useful? Click Contribute on GitHub under the settings icon to contribute to the open source project.
You can link to headings within your generated documentation, including the introduction, requests, folders, and responses.
The links are generated from your documentation using IDs. To find a link, click the relevant section in the left sidebar and you'll see it in your browser address bar (or right-click and copy the link). You can then link directly to doc page sections using this link.
You cannot link to another part of the documentation by manually creating an ID.
You can include any image you have hosted online in your documentation. Use the Markdown image syntax as follows:
![Image Alt Text](https://your-image-location.com)
You can use the Postman Markdown collection to see some Markdown styling inside Postman and rendered in the web documentation.
You can also see examples of documentation published using Postman collections by browsing the templates. Click New, select the Templates tab, choose a template, and click View Documentation.
The Postman API documentation is authored using Postman.
To make your documentation publicly available, check out Publishing your docs.