March 24, 2020

How to Use Postman to Test APIs

API Testing

This blog will give a step-by-step guide on how to use Postman to test your APIs in order to simplify the API testing process. 

APIs make it possible for any two separate applications to transfer and share data between them. They also make it easier for an application's users to execute actions without having to use the application’s GUI. From the developers' POV, it's an easy way to execute certain functionalities of their app and test it as well.

Using APIs on a daily basis might become cumbersome, as one might have dozens or even hundreds of APIs that he or she needs to use or test. That makes it difficult to keep up with their exact request’s address(es), header(s), authorization credential(s) etc. And it makes it harder to test the API for functionality, security, and exception handling.

Table of Contents:

What is Postman?

Postman is an API client that makes it easy for developers to create, share, test and document APIs. With this open-source solution, users can create and save simple and complex HTTP/s requests, as well as read their responses. 

In case you don’t have Postman installed, you’ll need to download it and install it.

Get the latest best practices for API monitoring & testing >>

Why Use Postman?

There are many benefits to using open-source Postman for API testing, including: 

  1. Accessibility from the cloud. When you are signed into your account, you are able to access your files. You can execute Postman API tests anytime, anywhere.
  2. Collaboration. Postman's import and export capabilities make it easier to share files with other team members, enabling closer collaboration. 
  3. Test Creation. You can add test checkpoints such as verifying successful HTTP response statuses to your Postman API calls. This capability can help teams achieve more comprehensive test coverage.  
  4. Automated API Testing. With features such as Collection Runner, you can automate Postman API tests, saving time and resources. 
  5. Simpler debugging. The Postman console makes it easier to debug API tests by helping teams check the retrieved data. 
  6. Collections. Postman's Collections features enables teams to group together multiple related APIs, which helps with organizing test suites.

How to Use Postman to Execute APIs 

Postman is very convenient when it comes to executing APIs. Once you’ve entered and saved them, you can simply use them over and over again, without having to remember the exact endpoint, headers, or API keys.

Here is a detailed example explaining how to enter a new API request using CA BlazeMeter’s ‘test create’ API, but you can do this for the product you are developing:

Launch Postman by clicking on the logo. After it completely loads the main screen follow this steps to create your collection of requests:

  1. On the “collections” tab click on the “+” button to create a new collection. A new collection will appear and you will be able to edit its name, description, and many other settings.
Collections tab in Postman
  1. Then right click on that new collection and select “add request” to create your first request.
Add Request in Psot
  1. Select the recently created request and enter the API endpoint where it says ‘Enter request URL’ and select the method (the action type) on the left of that field. The default method is GET but we will use POST in the example below.
Enter API endpoint in Postman

4. Add authorization tokens/credentials according to the server-side requirements. The different methods/protocols Postman supports are:

  • No Authentication
  • Basic Authentication (provide username and password only)
  • Digest Authentication
  • OAuth 1.0
  • OAuth 2.0
  • Hawk Authentication
  • AWS Signature
  • NTLM Authentication [Beta]

 

Add authorization tokens/credentials in Postman

 

5. Enter headers in case they are required.

Enter headers in Postman

 

  1. Enter a POST body in case it is required. In this example, we are creating a BlazeMeter test that requires a JSON payload with relevant details.
POST body Postman
  1. If you wish to execute this API now, hit the ‘Send’ button, which is located to the right of the API request field. You can also click on the ‘Save’ button beside it to save that API request to your library.
Enter API request to Postman

That’s it! Now you know how to enter your API request to Postman and save it to your library.

How to Create Postman Collections for Sharing BlazeMeter’s API

One of Postman’s fantastic features is ‘Collections’. ‘Collections’ allow you to group together several APIs that might be related, or perhaps should be executed in a certain sequence.

Postman Collections feature

For example, in the previous screenshot, you can see a collection that includes 4 APIs that are all required to create and run a BlazeMeter test. The first two APIs create the test object - the first of the two applies the necessary configuration, and the following API uploads the script file needed to run it. The last two APIs start and stop the test we created previously. Obviously, they should be executed in that sequence, hence the collection will be sorted accordingly.

Running a Postman Collection Using Collection Runner

In order to run a Postman Collection, you will need to use a feature called ‘Collection Runner’ following this steps: 

  1. In the Postman GUI, in the bottom right corner of the screen, click the ‘Runner’ button.
Postman GUI runner button

2. Drag and drop the desired collection or folder to the runner window. In our case, it will be the collection called ‘BlazeMeter API’.

BlazeMeter API collection in Postman
  1. There are additional configuration parameters that you may define. However, this is not mandatory. For example, you can specify the number of iterations you wish to run the collection for, as well as add delays between each API request. There is also an option to choose your ‘Environment’. Environments allow you to customize requests using variables that might include environment-specific values. This is extremely helpful when you are testing against several environments, like the development environment, the production environment, etc. To set up a new environment, click on the eye icon on the top right side of the Postman GUI and select ‘add’. You will be able to add a new one as well as its respective variables.
Choosing an environment in Postman

Using APIs Within Your Own App or Script With Postman

Postman also has a feature called ‘Snippets’. You can use it to generate code snippets in a variety of languages and frameworks, such as Java, Python, C, cURL and many others.

This is a huge time saver. A developer can easily integrate APIs with his or her own code without too much hassle. To use it, click on the code tab on the right side of the screen of Postman’s GUI.

Postman Snippets

You can now run API testing through BlazeMeter!

START TESTING NOW

 

Related Resources