Documentation is an important part of your API, helping consumers understand what endpoints are available and how to interact with them. Postman offers two ways to publish documentation for your collections: Postman documentation for quick API reference publishing, and Fern documentation for comprehensive documentation sites with guides and AI-powered features.
Postman automatically generates basic documentation for any collection you create, including request details, authorization type, and sample code. You can add descriptions to items in your collection to provide more context for users. This is a fast way to publish API reference documentation with minimal setup.
With Postman documentation, you can use the built-in editor to add descriptions, images, and videos. Postbot can also write documentation for you, automatically adding descriptions to your API requests including parameters and response examples.
Learn more at Document your APIs in Postman.
Fern is a docs-as-code platform that generates a documentation site from your Postman collection. When you publish, Fern automatically creates your API reference. From there, you can add guides, tutorials, and other content to build a complete documentation site.
Your documentation is deployed to a live site backed by a GitHub repository that your team owns. You get full edit rights and the flexibility to customize your site with custom branding, custom domains, and AI-powered features like intelligent search.
Learn more at Document your APIs with Fern.
You can create a Run in Postman button to share a collection and its documentation with users. When users click 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.