- 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
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. You can author documentation either from the collection in the Postman app, or directly in the docs when viewing them in the web browser.
- 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 also edit directly on the web for any documentation on a collection you have edit access to.
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 also edit descriptions in the web browser when you view documentation for collections where you have edit permissions.
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 also edit the request detail including the description directly from your docs in the browser—editable text will highlight on hover.
Click to edit a section of text.
Make your changes, and save them.
You will see a warning if your documentation contains any unsaved changes.
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.
If you edit your docs on the web, (following the links from your collection in the Postman app, or the dashboard when logged into your account in the browser), you will see helpers for common formatting options and be able to preview your changes.
To make your documentation publicly available, check out Publishing your docs.