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.
Postman automatically creates documentation for your collections, including request details, authorization type, and sample code. You can add descriptions to the items in your collection to provide more information for users. With types in collections, you can add details about your API with the Postman Collection format.
Postman also generates documentation based on your API specification. To create more detailed API documentation, generate a specification from a collection. Include descriptions and property types in your collection’s requests and responses.
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.
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 your Private API Network or Postman API Network.
Publishing a collection makes your documentation publicly available on getpostman.com or your own custom domain. As you update your collection, the published documentation automatically syncs with your latest changes.
You can’t publish a collection that’s linked to an API.
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.