Document your APIs in Postman

Documentation is an important part of your API. You can add documentation to any Postman Collection and its API requests. You can also use Postman to create API documentation and share it with your API's consumers, so they know what endpoints are available and how to interact with them.

Postman automatically generates documentation for your collections and APIs. To give your users more help and context, use Postman's built-in editing tools to add descriptions, images, videos, and more to your documentation.

Document collections and APIs

Postman automatically creates documentation for your collections, including request details, authorization type, and sample code. To provide more information for users, you can add descriptions to the items in your collection.

Postman also generates documentation based on your API definition (for OpenAPI 2.0 and 3.0 APIs). To create more detailed API documentation, add one or more collections to your API, and then add descriptions to the collections. You can add an existing collection or generate a collection based on your API definition.

Write your documentation

Add descriptions to your collections to enhance your documentation and provide more detail. You can use the Postman editor to view how your content will look as you write it, or use standard Markdown syntax to write content. With either editor, you can format text, add links, and insert images and videos.

Postbot can write documentation for you. Use Postman's AI assistant, Postbot, to automatically add descriptions to your API requests, including parameters and response examples. Learn more about writing documentation with Postbot.

Publish and view documentation

To learn more about how to use a collection or an API, you can view documentation in Postman. Collection documentation provides details for each request, along with sample code. To view API documentation, open an API in Postman, or search for APIs on the Private API Network or Postman API Network.

Publishing a collection makes your documentation publicly available on or your own custom domain. As you update your collection, the published documentation automatically stays in sync with your latest changes.

You can't publish a collection that's linked to an API. Instead, you can publish a version of an API to make your API and its documentation available to consumers.

Create a Run in Postman button

You can create a Run in Postman button to share a collection and its documentation with users. When users select the button, they have the option to fork the collection to their workspace, view the collection in a public workspace, or import the collection into Postman.

Last modified: 2024/01/17