{"id":1926,"date":"2022-06-17T06:00:58","date_gmt":"2022-06-17T06:00:58","guid":{"rendered":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/2022\/06\/17\/hitting-api-get-requests-with-postman\/"},"modified":"2022-06-17T06:00:58","modified_gmt":"2022-06-17T06:00:58","slug":"hitting-api-get-requests-with-postman","status":"publish","type":"post","link":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/2022\/06\/17\/hitting-api-get-requests-with-postman\/","title":{"rendered":"Hitting API GET Requests with Postman"},"content":{"rendered":"

<\/p>\n

\n

\n

\n

\n

<\/div>\n

\n

\n

<\/div>\n<\/div>\n

<\/div>\n

\n

<\/div>\n

\n

\n

Table of Contents<\/div>\n<\/p><\/div>\n<\/div>\n<\/div>\n

\n

\n

<\/div>\n

\n

\n

\n

Hitting API GET Requests with Postman<\/a><\/div>\n

1. What you will Learn in this blog ?<\/a><\/div>\n

2. Quick glance of workspace<\/a><\/div>\n

3. Hit GET request using Postman<\/a><\/div>\n

4. Brief understanding of response data output<\/a><\/div>\n

5. Brief understanding of Response Headers<\/a><\/div>\n

6. Brief understanding of Request Headers<\/a><\/div>\n

7. Send query parameter as part of GET request<\/a><\/div>\n

\u00a08. Add query parameter in the \u2018Params\u2019 section<\/a><\/div>\n

9.\u00a0Remove query parameter from the \u2018Params\u2019 section<\/a><\/div>\n

10.\u00a0History of Requests<\/a><\/div>\n

11.\u00a0Save the API calls<\/a><\/div>\n

12.\u00a0Create Collection of GET Requests<\/a><\/div>\n<\/div>\n

<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n

Hitting API GET Requests with Postman<\/b><\/h3>\n
Welcome you all to the brand new \u2018API Testing\u2019 blog series! In the previous blog, we had learnt how to setup Postman. In this tutorial, we will learn how to hit a GET request using Postman!! So let us begin!!!\u00a0<\/p>\n
\n

\n<\/ins>\n<\/div>\n
1. What you will Learn in this blog ?<\/b><\/b><\/h3>\n
\n
Quick glance of workspace<\/li>\n
Hit GET request using Postman<\/li>\n
Brief understanding of response data output<\/li>\n
Brief understanding of Response Headers<\/li>\n
Brief understanding of Request Headers<\/li>\n
Send query parameter as part of GET request<\/li>\n
Add query parameter in the \u2018Params\u2019 section<\/li>\n
Remove query parameter from the \u2018Params\u2019 section<\/li>\n
History of Requests<\/li>\n
Save the API calls<\/li>\n
Create Collection of GET Requests<\/li>\n<\/ul>\n
2. Quick glance of workspace<\/b><\/b><\/h3>\n
Let us open postman app and sign-in (in case you signed out in the previous blog). We can see the new workspace \u2018Postman WS\u2019 that we had created in our last blog\u00a0<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
To create a new tab, click + icon as shown below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
A new tab \u2018Untitled GET Request\u2019 gets created<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Also notice below that \u2018GET\u2019 is default method in the dropdown<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
If you click this dropdown, you would see other HTTP methods as well (example, POST, DELETE etc)<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We use the address bar to enter the URI that we would like to hit<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
To submit the request, we have to click the \u2018Send\u2019 button<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
3. Hit GET request using Postman<\/b><\/b><\/b><\/h3>\n
We will now see how to hit a GET request using Postman. Let us enter the URI https:\/\/httpbin.org<\/a> in the request url field<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click Send button.<\/p>\n
Notice below that we get the response data output (response body) from the server<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
4. Brief understanding of response data output<\/b><\/b><\/b><\/b><\/h3>\n
By default, response data is of type HTML as shown below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We can also see the status code 200 since the GET request is successfully processed by the server and the server was able to send us the response<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
As seen below, we can also see the total processing time of the API request alongwith the categorization of the processing time (example, Socket initialization took 62.22 ms and so on)<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Next, see below diagram. We can see the size of data which is being transferred as part of this request viz we can see the size of \u2018Response\u2019 body\/headers. This is the resource size which server sends back as a response<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We can also see the size of \u2018Request\u2019 headers as can be seen above.<\/p>\n
Click \u2018Preview\u2019. This tab shows the page preview as shown below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click \u2018Raw\u2019. This section shows the data in raw format<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We generally use \u2018Pretty\u2019 format as shown below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
In the Pretty format, we can see the data in HTML, JSON, XML etc formats<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
5. Brief understanding of Response Headers<\/b><\/b><\/b><\/b><\/b><\/h3>\n
The below diagram shows the \u2018Headers\u2019 of the response, example the \u2018Date\u2019 the request was created, content-type of the request which is text\/html etc<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
6. Brief understanding of Request Headers<\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
We know that some headers are automatically sent as part of request that we send to the server.<\/p>\n
See below, we can see 7 hidden headers that are being sent as part of the GET request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us click \u20187 hidden\u2019 to see the request headers, example User-Agent etc<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us copy the below URI<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Open the browser and launch the above URI, see below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We can see \u2018HTTP Methods\u2019 section as seen above.<\/p>\n
Let us click \u2018HTTP Methods\u2019. We can see various methods listed as can be seen below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us click GET method and expand its description. Notice below that we see a \/get<\/b> method that we can use in our query<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us go to the postman, open a new tab and append the \/get method to our GET request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click \u2018Send\u2019 to hit this request. The response of the GET request is as below. We can see arguments (which are currently zero), headers, url etc<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
7. Send query parameter as part of GET request<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
Let us now send some dummy query parameter as part of GET request. We have studied in previous blog that the query parameter starts with ?<\/b><\/p>\n
Let the append the dummy query parameter ?dummyparam=TestUser1<\/b><\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Hit Send. Notice below that we are getting the parameter as an argument in the response body<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us append another query parameter as part of the request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click Send. Notice now that we are getting both the parameters as an argument in the response body<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Also see below. Whatever query parameters we are sending as part of request, the same parameters get automatically created in the \u2018Params\u2019 section<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
\u00a08<\/b><\/b>. Add query parameter in the \u2018Params\u2019 section<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
The vice versa is also true. Let us add the 3^{rd<\/sup> query parameter in the \u2018Params\u2019 section as shown below<\/p>\n<\/div>\n}
$\"\"$ <\/span><\/div>\n
\n
Notice that this 3^{rd<\/sup> query parameter gets automatically appended to the request URI<\/p>\n<\/div>\n}
$\"\"$ <\/span><\/div>\n
\n
Hit Send and notice the expected output shown below<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
So this way, we can add the query parameters in the \u2018Params\u2019 section as well.
This way, we can test our API manually with different sets of query parameters.<\/p>\n
9<\/b><\/b>.\u00a0Remove query parameter from the \u2018Params\u2019 section<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
We can easily remove the query parameters by de-selecting the checkbox in the \u2018Params\u2019 section.<\/p>\n
Let us de-select dummyparam2<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Notice that dummyparam2 gets automatically removed from the URI as well<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click Send. Notice the response output. The dummyparam2 is not a part of arguments<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
10<\/b><\/b>.\u00a0History of Requests<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
We can see all the requests that we have executed in the \u2018History\u2019 section, see below. We can execute any of these if we want to<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
11<\/b><\/b>.\u00a0Save the API calls<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
The red colored small circles means that the API request has not yet been saved<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
To save any request, we have to click the \u2018Save\u2019 button<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
So let us click \u2018Save\u2019.<\/p>\n
The below window comes up showing the default \u2018Request name\u2019<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us write some meaningful \u2018Request name\u2019, example \u2018GETRequestWithQueryParams\u2019<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Notice above that the \u2018Save\u2019 button is still disabled. The reason being, this request is not yet part of any collection.<\/p>\n
12<\/b><\/b>.\u00a0Create Collection of GET Requests<\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/b><\/h3>\n
Click \u2018Create a collection\u2019 button seen in the above figure. The below window would come up<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Enter some meaningful name in the \u2018Name your collection\u2019 text field<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Click \u2018Create\u2019 button seen next to the collection name text field (see above figure). The below window would come up<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Now we can see that \u2018Save\u2019 button is enabled.<\/p>\n
Click \u2018Save\u2019. Notice below that red circle is not seen and the request gets saved<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We can see our collection in the \u2018Collections\u2019 section<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
\u00a0When we expand this collection, we can see our saved request(s)<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Similarly let us save below request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Let us give some name<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Save.<\/p>\n
Notice below that we now have 2 requests saved in a single collection<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
We can now click any of the above requests and hit the \u2018Send\u2019 button to execute the request.<\/p>\n
Below shows execution of \u2018GETRequestWithoutParams\u2019 request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
Below shows execution of \u2018GETRequestWithQueryParams\u2019 request<\/p>\n<\/div>\n
$\"\"$ <\/span><\/div>\n
\n
So this is how we execute the GET Requests in Postman. In the next blog, we will see how to work with POST requests. We will also see how to chain GET and POST requests.<\/p>\n
Thank you for reading!<\/p>\n<\/div>\n<\/div>\n<\/div>\n
<\/div>\n<\/section>\n
<\/body><\/html><\/p>\n","protected":false},"excerpt":{"rendered":"
Table of Contents Hitting API GET Requests with Postman 1. What you will Learn in this blog ? 2. Quick glance of workspace 3. Hit GET request using Postman 4. Brief understanding of response data output 5. Brief understanding of Response Headers 6. Brief understanding of Request Headers 7. Send query parameter as part of […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[12],"tags":[],"class_list":["post-1926","post","type-post","status-publish","format-standard","hentry","category-api","post-wrapper","thrv_wrapper"],"_links":{"self":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/1926","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/comments?post=1926"}],"version-history":[{"count":0,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/1926\/revisions"}],"wp:attachment":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/media?parent=1926"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/categories?post=1926"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/tags?post=1926"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}