![]() ![]() ![]() With Postman Team, Business, or Enterprise, you can opt to use a custom domain for your public documentation site. ![]() This gives you the chance to update the documentation before publishing it. Postman will also highlight identified secrets throughout the page. If Postman identifies a potential secret, you will see a banner at the top of this window. In this live preview, Postman scans the documentation for anything that appears to be a sensitive token. This opens a live preview of the documentation in another window which reloads on any change. You can preview your documentation before publishing it. Select an environment to populate variables in your published documentation.Select a collection version to publish.In the Publish Collection page, you can configure how you want your public docs to appear. Remove all sensitive information from the environment before you publish. From here, select Publish to publish your collection.Īny confidential information in your environment, such as passwords and access tokens may become publicly visible when you publish your docs. To publish from the collection in Postman, select the collection in Collections, open the actions menu (. To publish from your collection's private documentation in the web browser, select a version and click Publish. You can publish docs from an existing private documentation page or from the collection in Postman. You can publish documentation for collections that you created or have permission to edit. You can publish your documentation to the API Network or as a template to make your collections publicly available in Postman, aiding developer onboarding and adoption. For example, check out the Postman API documentation-generated from a Postman Collection. Your documentation will include the Run in Postman button so users can interact with your API directly in Postman. You don’t need to repeat the publication flow each time you want to update your documentation. Your public documentation will always display up-to-date content representing the current state of your collection. 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. You can publish your API documentation to make it available for public viewing by anyone who has the link. ![]()
0 Comments
Leave a Reply. |