Like all documentation in Postman, documentation for an API must be part of a collection. A collection can be linked to only one version of an API. If you create a new version of your API, you'll also need to generate a new collection to hold that version's documentation. To learn more, see Versioning your docs.
You can generate additional documentation collections from the Documentation tab. Select the Collection dropdown list, and then select Create new documentation. You can add additional documentation collections from the Documentation tab. Select the Collection dropdown list, and then select Add existing documentation.
You can add to your API documentation right from the Documentation tab. Just select the edit icon next to any description and use the built-in editing tools to author content. Another way to work on your API documentation is to open the linked collection. On the Documentation tab, select View Collection , and then edit the documentation in the linked collection. When you're done, link the documentation to your API.
Removing documentation only removes the link between the collection and the API version. The collection itself is not deleted.
An environment is a set of related variables you can use in Postman requests. You can also refer to variables when authoring descriptions in a collection. In each case, the initial value of the variable is automatically populated in the documentation. Anyone using your collection will only be able to view the variables in the documentation if the associated environment is also shared with them. For public documentation, you can select an environment during the publishing process.
Publishing an environment makes it available to anyone viewing public documentation. If someone imports a collection using the Run in Postman button from your documentation, they will also import the environment and any associated variables.
The initial values for variables are published in your documentation, so make sure they don't contain any sensitive data. A version is a set of features and functionality that your API delivers to consumers. That means, when you create a new version of your API, you'll also need to create a new documentation collection. You can then use the new collection to author documentation for the new API version.
Carry over documentation when creating an API version. When you create a new API version , you have the option to copy elements from a previous API version into the new version. Select the Documentation element, and then select Create Version. This will create a new documentation collection based on the previous collection, with the new version name appended to the collection name. Seizure warnings Photosensitive seizure warning.
Report this product Report this app to Microsoft Thanks for reporting your concern. Our team will review it and, if necessary, take action. Sign in to report this app to Microsoft. Report this app to Microsoft.
Report this app to Microsoft Potential violation Offensive content Child exploitation Malware or virus Privacy concerns Misleading app Poor performance. How you found the violation and any other useful info. Submit Cancel.
System Requirements Minimum Your device must meet all minimum requirements to open this product OS Windows 10 version Recommended Your device should meet these requirements for the best experience OS Windows 10 version Open in new tab. Sign me up Stay informed about special deals, the latest products, events, and more from Microsoft Store.
Chrome, Firefox, Safari, Opera. Please let us know via the feedback form if you have any issues. What is ezyZip? It supports a myriad of other file formats and conversions. It runs locally as a browser app, thus making it much quicker than other online file extractors. This also ensures your privacy will be protected as no file data will leave your browser. What is a rar file? It was first released by Russian software engineer Eugene Roshal in It purports to have better compression speed, encryption and error handling than the ZIP format.
0コメント