Let's close the browser and return to Postman. All of this together, makes it incredibly easy for anyone with access to your collection to know exactly what to expect when working with your API. It contains a number of useful features, including the ability to include a unit test. Additionally, the documentation we provided for the content header is also displayed along with its value. Postman is a collaborative platform for designing and building APIs. Notice how both the request and response changed to reflect the saved examples. Click the arrow and choose the other option. This indicates that the valid user example is shown. In the right panel, you'll see the valid user name and a drop down arrow. Click the authorization request in the side bar. Any custom examples attached to a request definition are also depicted in the documentation viewer. Moving down the page, notice how the descriptions we provided for the collections and folders are displayed. Build your own example by following this step-by-step tutorial, or fork the example collection and environment in this workspace to follow along. Let’s look at three ways to securely work with API keys. I'm going to switch back to cURL to keep the example short. If you want to join along in Postman with more detailed explanations, import the full tutorial here and follow the step-by-step documentation. When I selected node, all of the request examples changed to how they'd appear as written in node.js. Click the cURL option and change over to another format to see the examples changes automatically. By default, the documentation viewer shows request examples in cURL format. Here we can navigate through the collection, select code example format, and read all of the enter documentation. Postman opens your default browser and directs you to a private page where your entire collection is presented in a consumable format consistent with the documentation structure used by numerous popular APIs. It's far easier to review the documentation on the web. This is one way to view the documentation, but it's hardly a comprehensive guide to the API. Click authorization again to hide the description. Click on authorization to see that request's description. Clicking on any of those items will take you to that item's information. Here you can see the collection's description along with a list of the folders and requests that it contains. Open the Postman Sample API collections information panel by clicking the corresponding arrow icon. All of the documentation we've entered is available within the Postman interface.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |