Publishing your docs

Publishing your documentation makes it publicly available to anyone with the link to the documentation and a web browser. Publish your documentation to help people around the world learn how to use your collection or interact with your Public API.

Public documentation automatically includes details for each request or endpoint in the published collection, along with sample code in various client languages. As you modify your collection, the published documentation automatically stays in sync with your latest changes. There's no need to publish the documentation again after making changes.

Your public documentation includes the Run in Postman button so users can interact with your collection or API directly in Postman. For an example, check out the Postman API documentation which was published from a Postman collection.

Contents

Making your documentation public

To publish documentation, it must be part of a collection. You can publish documentation for any collections that you created or have permission to edit.

To publish the documentation for a collection:

  1. Select Collections in the left sidebar.

  2. Select the three dots Three dots icon next to a collection, and then select View Documentation.

  3. Select Publish at the upper right.

    Publish documentation
  4. Change any publication settings as needed:

    • Release tag: Select one or more release tags to publish. Users can view documentation for each selected release.
    • Environment: Select an environment to publish environment variables with your documentation. The initial values of all variables are published with your documentation, so make sure they don't contain sensitive information such as passwords or tokens.
    • Custom domain: Select a custom domain where you want to publish your documentation.
    • Default layout: Select a layout style for your documentation. Double column displays sample code in a column to the right of the documentation. Single column displays sample code inline beneath each request.
    • Header background color: Specify a color (hex format) for the header at the top of the documentation window.
    • Code background color: Specify a color (hex format) for sample code blocks.
    • Highlight color: Specify a color (hex format) for hyperlinks.
    • Move to public workspace: (Optional) Select an available public workspace to move the collection to. This will make the collection discoverable on the Public API Network, along with its documentation.
  5. To see what your documentation will look like using the current settings, select Preview Documentation. The preview automatically updates as you change settings.

    If Postman detects a possibly sensitive token or other secret, a warning appears at the top of the preview window. Postman also highlights the token so you can remove it from the documentation before publishing.

  6. When you are finished changing settings, select Publish Collection. You can view your public documentation at the provided URL.

Published documentation example

If you are a team admin, you can customize your published documentation with a team logo. To add a logo, edit your team profile in your team settings. Your team logo will replace the Postman logo in your team's published documentation. (It may take a few minutes for the new logo to appear.)

Sharing your public docs

To share your public documentation, simply share the published URL with your team members, other users, or the community. If you have forgotten the URL for your published documentation, you get it at any time:

  1. Select Collections in the left sidebar.
  2. Select the three dots Three dots icon next to a collection with published docs, and then select View Documentation.
  3. Select Published at the upper right, and then select Copy published link.
Copy published link

If your collection is in a public workspace, others can search for and find your collection on the Public API Network, along with its documentation. If you haven't already moved your collection to a public workspace, you can do so at any time by changing the publication settings.

By sharing your documentation with the Public API Network, you increase the visibility of your API to a wider range of consumers in the Postman community. Learn more about public workspaces.

Changing publication settings

Change the publication settings for your documentation to add a release, update your documentation's look, or make your collection public. You can change the publication settings at any time after publishing your documentation:

  1. Select Collections in the left sidebar.

  2. Select the three dots Three dots icon next to a collection with published docs, and then select View Documentation.

  3. Select Published at the upper right, and then select Edit published documentation.

    Edit published documentation
  4. Select Edit settings, and then change the publication settings as needed.

  5. Select Save and republish.

Unpublishing your docs

If you no long want your documentation to be publicly available, you can unpublish it:

  1. Select Collections in the left sidebar.
  2. Select the three dots Three dots icon next to a collection with published docs, and then select View Documentation.
  3. Select Published at the upper right, and then select Edit published documentation.
  4. Select Unpublish.

If you change your mind, you can publish your documentation again at any time.

Unpublish documentation

Next steps

Learn more about viewing documentation.

Last modified: 2021/12/08