- Testing Tools
- Testing Companies
Postman is a great tool for prototyping APIs, and it also has some powerful testing features. Mike shares how to integrate Postman's tests into your build automation to make things really take off.
I've used Postman on a few projects as a way to interact with APIs that I'm writing. As a tool to setup complex HTTP requests, it's much more convenient than request specs, Cucumber, or hand-rolling them in even your favorite HTTP library. One admittedly huge advantage these other methods have had for me in the past is the ability to integrate them with my regular testing tools—but no more. The people behind Postman have released a command-line tool for running Postman collections called Newman. Let's take a look at how to use Newman to get more out of Postman.
If you already have Jetpacks, you can follow the example here—be sure to click the import tab in Postman and use the Download from link tab to import the collection.
Google's URL shortener expects a single parameter enclosed in a JSON document. Let's construct a request and make sure Google's response actually gives us a short URL. This is what Postman should look like once that has been set up.
Postman pretty-prints the response, and it looks like Google's API is working.
If this were our own API, we would go further and make similar assertions about HTTP status codes and the expected failure responses our API generates. Not pictured in these examples are Postman's examples to the right of your test code. They show you several ways you can measure how your API behaves and performs.
This is all well and good, but opening Postman is an extra step to your existing tests. If we're honest, that just means that none of this will get used after we've spent so much time on it. This is where Newman comes in. Installation is via npm, but before we can run it, we need a file from Postman. If you downloaded the collection above, this should already appear in the sidebar. If not, add the request you've made yourself to a collection and use the share link to download it as JSON. Save that file with your other project files.
I haven't found a ruby gem that integrates Newman with Rake, but at least until something more sophisticated comes along, Ruby's system command will suffice well enough. Newman is a good Unix citizen, and we can evaluate its return code to determine if there were any errors during execution. This should drop seamlessly into whatever continuous integration tool you use and interrupt builds just like any other test failure.
With Newman, you can integrate Postman collections with your build system. Or you can run automated tests for your API through a cron job. You can also use Newman as a grunt plugin to run your API tests any time you save your code in your editor. There are tons of other ways to use Newman and we can't wait for you to try it out!
The setup involved is absolutely minimal. You can check out the Newman repository on Github: https://github.com/a85/Newman for more details. The code is licensed under the Apache license. Your contributions are welcome!
This has been one of the top feature requests since the release of Jetpacks and we are very excited to show this to you.
Read More...check-out reference url