–Kevin Farnham API Monitoring, Integrations. We’ve now created an API collection in Postman, imported it into your API Science account, and created a monitor that will let you assess this API’s performance and uptime, and alert your team should the API go down. Clicking on the monitor brings up our first check page: This brings us to our API Science Dashboard, which now includes the new monitor GET (the monitor name is editable). Select the file you exported from Postman, and click the “Create Monitors” button: To start working with a Postman collection, you need to save it as a file: In the Postman application in Chrome, select your collection and click Download. So, we click the “Import from File” tab then click the “Browse” button: In this case, we exported our Postman collection to a file. Now, go to your API Science Dashboard, click “Import” at the top of the page, then click the “Import From Postman” button: From our Collections tab, we click the “…” next to our “World Bank Arctic Countries” collection, and this raises a pull-down menu that includes an “Export” option that lets us save our Postman collection to a file: Postman Collections are Executable API Descriptions Postmans collection folders make it easy to keep your API requests and elements organized. Next, you can export your Postman collection. In this case, I’m creating a new Postman collection named “World Bank Arctic Countries.” Clicking the “Save” button accomplishes this. This results in a pop-up that lets us enter a description of this request and either add it to an existing Postman “collection” or create a new one: So, having successfully created your Postman test request, can you turn this into an API Science monitor?įirst, let’s click that “Save” button on the Postman result window. This is the type of information that is provided to you by your API Science account. In any case, if this API is a component of your product, you will want to know when, and how often, the API is down, or when its performance is poor. To use the Postman Collections provided further down this page (and on each individual API doc page), youll need to set up environment variables in Postman. How can you know when that information is available, and when it is not available? If the World Bank Canada information is not available, your product/app may appear “down” to your users. Let’s assume your company’s product is focused on providing information about the state of the Arctic Ocean, and you use the World Bank information about the nations that have coastlines on the Arctic Ocean. The GET query succeeded: the World Bank Countries API responded by sending the information about Canada, including region, income level, capital, etc. As its name implies, the Collection Runner (CR) lets you run all requests inside a Postman collection one or more times. Postman’s Collection Runner is a powerful tool. Based on this, we can create a World Bank Countries API GET request using this URL: Įntering this into the Postman “Enter request URL” field and clicking the “Send” button produces this result: Octo5 mins Update: If you want to dip deeper into the Postman Collection Runner, check out this newer post about Postman’s Collection Runner. The two-letter ISO code for Canada is CA. The World Bank Countries API supports two- and three-letter ISO codes. Let’s say we’d like to query the World Bank’s Countries API for information about Canada. Now we’re ready to use the Postman Builder to create a request. POSTMAN Sharing Collection Click on Share. I downloaded this from the Postman Apps page, ran the installer, and launched the Postman application: Open the POSTMAN app, go to the collection tab in the sidebar and click on the three dots -> share collection. In this post, the examples I present use the Windows native Postman app. Postman is available as a Chrome app, but the Postman team recommends the more powerful native apps, which are available for Mac, Windows, and Linux (Beta). The fundamental building block for a Postman application is a “collection” - which consists of one or more API requests, and scripted actions based on the response each request returns. You are receiving this because you were mentioned.Postman is a platform that enables you to construct API requests and workflows, test integration suites, document your work, and share your finished product with your team and others. Triage notifications on the go with GitHub Mobile for iOS or Android. Reply to this email directly, view it on GitHub, or unsubscribe. Our team will update this thread once resolved. Do not click links or open attachments unless you recognize the sender and know the content is Apologies but this hasn't been fixed yet. To: postmanlabs/postman-app-support Robert Duncan Mention Re: Cannot save documentation on collections or requests (Issue #10477)ĬAUTION: This email originated from outside of the organization.
0 Comments
Leave a Reply. |