Intro to API documentation
Postman’s API documentation feature lets you share public or private API documentation in a beautifully formated 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 that’s available to your team, click “View in web” in the Postman app or in the “Team Library”.
When you publish your documentation, you can use the public link to view the documentation. The public link displays after you publish your documentation. The documentation is also accessible in the “Published” dropdown in the private documentation view.
Creating a documentation
You can create documentation from the:
- New button
- Launch screen
New button
- In the header toolbar, click the New button.
The Create New tab appears.
Note: At the bottom, you can select “Show this window at launch” to indicate whether you want the Create New tab to display each time you open Postman.
- Click "API Documentation".
- Select if you want to create documentation for a new API or an existing or team collection. If you create a new API to document, you must select a request method and enter the request URL, description, and status code. If you use an existing or team collection to document, you must select a collection from a list of existing or team collections.
- After you select or create the request you want to document, click the Next button.
- In the Configure documentation tab, you must:
- Enter the name of the documentation.
- Add a description of the documentation. You can use markdown to add headings, lists, code snippets, and so on in your description.
- Click the Create button.
In the Next steps tab, see a list of suggested next steps to maximize the effectiveness of your documentation.
Launch screen
The Create New tab appears by default when you launch Postman.
- Open the Postman app.
- In the Create New tab, click “Documentation”.
- Follow step 3-6 in the previous New button section.
Note: At the bottom, you can select “Show this window at launch” to indicate whether you want the Create New tab to display each time you open Postman.
What gets automatically generated?
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
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.
We support 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.
Free documentation views with your Postman account
Your Postman account gives you a limited number of free documentation views per month. You can check your usage limits through the Postman API or the account usage page.