Publishing your docs

You can publish your API documentation to make it available for public viewing by anyone who has the link. Published documentation allows anyone who wants to learn how to use your API to view detail on endpoints, including parameters, request and response bodies, and example code.

Your public documentation will always display up-to-date content representing the current state of your collection. You don’t need to repeat the publication flow each time you want to update your documentation.

You can publish documentation for collections that you created or have permission to edit.

Contents

Making your documentation public

You can publish docs from an existing private documentation page or from the collection in the Postman app.

To publish from your collection's private documentation in the web browser, select a version and click Publish.

Publish Docs

To publish from the collection in the Postman app, select the collection in Collections, open the actions menu (...), and choose Publish Docs.

Publish Docs

Any confidential information in your environment, such as passwords and access tokens may become publicly visible when you publish your docs. Remove all sensitive information from the environment before you publish.

Configuring your public docs

In the Publish Collection page, you can configure how you want your public docs to appear.

  • Select a collection version to publish.
  • Select an environment to populate variables in your published documentation.

Publish Config

You can preview your documentation before publishing it.

Customizing your docs

With Postman Team, Business, or Enterprise, you can opt to use a custom domain for your public documentation site.

You can configure the style of your public docs by selecting colors for the top bar, sidebar, and highlights. Try making changes and preview to see how your docs will appear when published.

Style Docs

You can customize the style of your public docs by adding a team name and logo via your team settings if you have admin access. Your logo will replace the Postman logo in your team's published docs—updated logo images may take a few minutes to appear.

Sharing your public docs

To share your API documentation with your users and the wider Postman community, enable Collection discovery by toggling the switch.

Collection Discovery

You can only add to API Network when publishing from a team. You can configure your team profile by clicking Public Profile Settings, enabling your profile, and filling out your team details for display.

Publish as Team

Enable Profile

Your team profile can include a name, description, custom URL, and logo.

Profile Detail

Add listing details for your public documentation, including name, summary, description, and relevant tags.

Listing Detail

If you do not want to make your docs discoverable at this time, you can go ahead and publish then add them to the API Network or Postman Templates later.

Publishing and unpublishing

Once you have your publish settings complete, click Publish Collection to make your docs public.

Publish Docs

You will see a confirmation that your docs are public together with a link you can share.

Docs Published

You can unpublish your docs at any time by clicking Unpublish.

Unpublish Docs

Next steps

Find out more about sharing your docs via the API Network and Templates.