From 19aac8b3f435947b74964255d061d2c95e40da05 Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sat, 8 Apr 2023 12:35:02 +0530 Subject: [PATCH 01/13] added main folder --- learning/dashboard/Group 4/test.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 learning/dashboard/Group 4/test.txt diff --git a/learning/dashboard/Group 4/test.txt b/learning/dashboard/Group 4/test.txt new file mode 100644 index 00000000..6991197c --- /dev/null +++ b/learning/dashboard/Group 4/test.txt @@ -0,0 +1 @@ +Nothing to see here \ No newline at end of file From f8eebe7efb91f62f44577d43e18f60140bdd2669 Mon Sep 17 00:00:00 2001 From: chirag kumar <74717424+ichiragkumar@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:54:04 +0530 Subject: [PATCH 02/13] 21BCAD15 here i have added readme files how you should use postman at very first bigginer level --- learning/dashboard/Group 4/reademe.md | 38 +++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 learning/dashboard/Group 4/reademe.md diff --git a/learning/dashboard/Group 4/reademe.md b/learning/dashboard/Group 4/reademe.md new file mode 100644 index 00000000..e8a3a3e8 --- /dev/null +++ b/learning/dashboard/Group 4/reademe.md @@ -0,0 +1,38 @@ +# **POSTMAN** + +*I will show how easy it is to use postman as a beginner* + +**Just open your application** + +![](https://i.imgur.com/LRI7l6I.png) + +*Open Postman and select "workspace"* + +![](https://i.imgur.com/JFzKUuq.png) + +*In workspace section section, click on new* + +![](https://i.imgur.com/mRfSIc4.png) + +*AFter that, click you will get an window like this ==> **Click on http Request*** + +![](https://i.imgur.com/1wAT25e.png) + +*In The Get section : You will see Input box **( in Blue box you have to put api key or json )*** + +![](https://i.imgur.com/sRVBSoL.png) + +*and then press the button send* + +*after that you will get an **json response with 200 success message*** + +![](https://i.imgur.com/ZapU4PC.png) + +*This is how you can use postman . 😊😊😊😊* + +*Open Your postman and come to workspace section and then click on new button and you will see get with input box. here you have to put yout api and then click on send button .. with 200 success message you will get an json response ( this is how you can use any api in postman)* + + + + + From d0fb041c2e0a1d9ff1303fea2290cfaf900f8ed3 Mon Sep 17 00:00:00 2001 From: ASHAE847 Date: Sat, 8 Apr 2023 17:42:32 +0530 Subject: [PATCH 03/13] Added Postman Installation Tutorial --- learning/dashboard/Group 4/Postman1.md | 76 ++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 learning/dashboard/Group 4/Postman1.md diff --git a/learning/dashboard/Group 4/Postman1.md b/learning/dashboard/Group 4/Postman1.md new file mode 100644 index 00000000..bca05d55 --- /dev/null +++ b/learning/dashboard/Group 4/Postman1.md @@ -0,0 +1,76 @@ +# Postman +![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) + +Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. + +This tutorial will help in understanding why Postman is so famous and what makes it unique when compared to other API testing tools. All the examples in this tutorial are tested and can be imported in Postman. +
+
+## Reasons to use Postman +Postman is based on a wide range of extremely user-friendly power tools. For more than 8 million users, Postman has become a tool of convenience. Following are the reasons why Postman is used +- Accessibility: One can use it anywhere after installing Postman into the device by simply logging in to the account. +- Using Collections: Postman allows users to build collections for their API-calls. Every set can create multiple requests and subfolders. It will help to organize the test suites. +- Test development: To test checkpoints, verification of successful HTTP response status shall be added to every API- calls. +- Automation Testing: Tests can be performed in several repetitions or iterations by using the Collection Runner or Newman, which saves time for repeated tests. +- Creating Environments: The design of multiple environments results in less replication of tests as one can use the same collection but for a different setting. +- Debugging: To effectively debug the tests, the postman console helps to track what data is being retrieved. +- Collaboration: You can import or export collections and environments to enhance the sharing of files. You may also use a direct connection to share the collections. +- Continuous integration: It can support continuous integration. +- Application development: Accelerate application development with Postman eliminates dependencies and reduces the time taken by production by having the frontend and backend teams work in parallel. +
+
+## Audience +This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. + +After completion of this tutorial, you will get a basic level of understanding of Postman and API testing. This tutorial will also give you a good understanding of how to use Postman to execute APIs for any given URL for your daily work. +
+
+## Installation and Updates + Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. +
+
+### Steps to download and install the native Postman application + +* Step 1: Go to the link https://www.postman.com/downloads/ and click download for Mac or Windows or Linux based on your operating system.

+![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png) + +* Step 2: For downloading the app for Windows, click on the download button and select the particular version. I opted for the 64-bit version. If you are using a 32-bit OS, you can choose the 32 bit, as shown in the above image. + +* Step 3: You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates2.png)

+It is better to create an account as this will help you to save the work you do within the Postman, and with this, you won't lose any work. + +* Step 5: Create your account with all the required details, or you can also signup with Google, as shown in the image.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates4.png) + +* Step 6: After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) + +* Step 7: You will see the following page, and then you are ready to use Postman.
+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png) +
+
+### Steps to update the Postman desktop client + +* You will receive a notification in your Postman app if any update is available. + +* To download or install the latest update, click on the Settings icon, as shown in the image below, go to Settings>Update.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates7.png) + +* You can change the update settings by enabling the settings of automatically download major updates, as shown in the image below

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates8.png) + +* You can also check for the latest updates by clicking on Check for updates, which will show you if any new update is available. + +* You will have to select the update option to download and install the latest update. When the download is complete, you will see a notification asking you to restart the app to install the updated features. + +* It automatically downloads minor updates and bug fixes. + + + + + + + + + From b4910c9f72dd02df67fdb9581a124f96b733bf4b Mon Sep 17 00:00:00 2001 From: hackerlakshmi Date: Sat, 8 Apr 2023 19:25:33 +0530 Subject: [PATCH 04/13] Modified Postman.md, added Ubuntu installation --- learning/dashboard/Group 4/Postman1.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/learning/dashboard/Group 4/Postman1.md b/learning/dashboard/Group 4/Postman1.md index bca05d55..f148638b 100644 --- a/learning/dashboard/Group 4/Postman1.md +++ b/learning/dashboard/Group 4/Postman1.md @@ -6,7 +6,9 @@ Postman is one of the most popular software testing tools which is used for API This tutorial will help in understanding why Postman is so famous and what makes it unique when compared to other API testing tools. All the examples in this tutorial are tested and can be imported in Postman.

+ ## Reasons to use Postman + Postman is based on a wide range of extremely user-friendly power tools. For more than 8 million users, Postman has become a tool of convenience. Following are the reasons why Postman is used - Accessibility: One can use it anywhere after installing Postman into the device by simply logging in to the account. - Using Collections: Postman allows users to build collections for their API-calls. Every set can create multiple requests and subfolders. It will help to organize the test suites. @@ -19,17 +21,22 @@ Postman is based on a wide range of extremely user-friendly power tools. For mor - Application development: Accelerate application development with Postman eliminates dependencies and reduces the time taken by production by having the frontend and backend teams work in parallel.

+ ## Audience + This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. After completion of this tutorial, you will get a basic level of understanding of Postman and API testing. This tutorial will also give you a good understanding of how to use Postman to execute APIs for any given URL for your daily work.

+ ## Installation and Updates + Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has.

-### Steps to download and install the native Postman application + +### Steps to download and install the native Postman application on Windows * Step 1: Go to the link https://www.postman.com/downloads/ and click download for Mac or Windows or Linux based on your operating system.

![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png) @@ -50,6 +57,19 @@ It is better to create an account as this will help you to save the work you do ![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png)

+ +### Steps to download and install the native Postman application on Linux (Ubuntu) + +To install the latest version of the Postman desktop app, you need to install it via the Snap using the following commands. +``` +$ sudo apt update +$ sudo apt install snapd +$ sudo snap install postman +``` +This is the simplest way to install Postman on Linux/Ubuntu systems. +
+
+ ### Steps to update the Postman desktop client * You will receive a notification in your Postman app if any update is available. From 682b85f7554e07fb3be17d6f01af7785c4452b56 Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sun, 9 Apr 2023 10:23:36 +0530 Subject: [PATCH 05/13] Modified Postman usage tutorial --- learning/dashboard/Group 4/reademe.md | 31 +++++++++++---------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/learning/dashboard/Group 4/reademe.md b/learning/dashboard/Group 4/reademe.md index e8a3a3e8..ea409cd0 100644 --- a/learning/dashboard/Group 4/reademe.md +++ b/learning/dashboard/Group 4/reademe.md @@ -1,36 +1,29 @@ -# **POSTMAN** +# Using Postman -*I will show how easy it is to use postman as a beginner* - -**Just open your application** +The following tutorial will show you how to use Postman after properly installing and setting it up. +1. Open your Postman desktop application

![](https://i.imgur.com/LRI7l6I.png) -*Open Postman and select "workspace"* - +2. Open Postman and select "workspace"

![](https://i.imgur.com/JFzKUuq.png) -*In workspace section section, click on new* - +3. In workspace section section, click on new

![](https://i.imgur.com/mRfSIc4.png) -*AFter that, click you will get an window like this ==> **Click on http Request*** - +4. After that, you will be greeted by a dialog box as seen below, click on *HTTP Request*

![](https://i.imgur.com/1wAT25e.png) -*In The Get section : You will see Input box **( in Blue box you have to put api key or json )*** - -![](https://i.imgur.com/sRVBSoL.png) - -*and then press the button send* - -*after that you will get an **json response with 200 success message*** +5. You will see an input box in the Get section as highlighted below, you will have to put your API key or JSON in this box.

+![](https://i.imgur.com/sRVBSoL.png)

+Then all you need to do press the *Send* button +6. You will then be greeted with the following json response message, typically look for *200 OK* for a successful response

![](https://i.imgur.com/ZapU4PC.png) -*This is how you can use postman . 😊😊😊😊* +
+Provided you followed all the above steps properly, you have now successfully used Postman to get a postivie response from an API. -*Open Your postman and come to workspace section and then click on new button and you will see get with input box. here you have to put yout api and then click on send button .. with 200 success message you will get an json response ( this is how you can use any api in postman)* From 2a1f3d2d3aedf42d1c798249a959ae1699926f11 Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sun, 9 Apr 2023 11:00:24 +0530 Subject: [PATCH 06/13] Further modified Postman installation tutorial --- learning/dashboard/Group 4/Postman1.md | 80 +++++++++++++++----------- 1 file changed, 45 insertions(+), 35 deletions(-) diff --git a/learning/dashboard/Group 4/Postman1.md b/learning/dashboard/Group 4/Postman1.md index f148638b..82ac0742 100644 --- a/learning/dashboard/Group 4/Postman1.md +++ b/learning/dashboard/Group 4/Postman1.md @@ -1,28 +1,12 @@ -# Postman -![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) - -Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. +# Postman and it's usage -This tutorial will help in understanding why Postman is so famous and what makes it unique when compared to other API testing tools. All the examples in this tutorial are tested and can be imported in Postman. -

-## Reasons to use Postman +![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) -Postman is based on a wide range of extremely user-friendly power tools. For more than 8 million users, Postman has become a tool of convenience. Following are the reasons why Postman is used -- Accessibility: One can use it anywhere after installing Postman into the device by simply logging in to the account. -- Using Collections: Postman allows users to build collections for their API-calls. Every set can create multiple requests and subfolders. It will help to organize the test suites. -- Test development: To test checkpoints, verification of successful HTTP response status shall be added to every API- calls. -- Automation Testing: Tests can be performed in several repetitions or iterations by using the Collection Runner or Newman, which saves time for repeated tests. -- Creating Environments: The design of multiple environments results in less replication of tests as one can use the same collection but for a different setting. -- Debugging: To effectively debug the tests, the postman console helps to track what data is being retrieved. -- Collaboration: You can import or export collections and environments to enhance the sharing of files. You may also use a direct connection to share the collections. -- Continuous integration: It can support continuous integration. -- Application development: Accelerate application development with Postman eliminates dependencies and reduces the time taken by production by having the frontend and backend teams work in parallel. -

-## Audience +Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. @@ -30,48 +14,70 @@ After completion of this tutorial, you will get a basic level of understanding o

-## Installation and Updates +## Installation, Setup and Updates + +
Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has.

-### Steps to download and install the native Postman application on Windows +### Downloading and installing the native Postman application on Windows + +
-* Step 1: Go to the link https://www.postman.com/downloads/ and click download for Mac or Windows or Linux based on your operating system.

+* Go to the link https://www.postman.com/downloads/ and click download for Mac or Windows or Linux based on your operating system.

![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png) -* Step 2: For downloading the app for Windows, click on the download button and select the particular version. I opted for the 64-bit version. If you are using a 32-bit OS, you can choose the 32 bit, as shown in the above image. +* For downloading the app for Windows, click on the download button and select the particular version. I opted for the 64-bit version. If you are using a 32-bit OS, you can choose the 32 bit, as shown in the above image. -* Step 3: You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

+* You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates2.png)

It is better to create an account as this will help you to save the work you do within the Postman, and with this, you won't lose any work. - -* Step 5: Create your account with all the required details, or you can also signup with Google, as shown in the image.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates4.png) - -* Step 6: After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) - -* Step 7: You will see the following page, and then you are ready to use Postman.
-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png)

-### Steps to download and install the native Postman application on Linux (Ubuntu) +### Downloading and installing the native Postman application on Linux (Ubuntu) -To install the latest version of the Postman desktop app, you need to install it via the Snap using the following commands. +
+ +To install the latest version of the Postman desktop app, you need to install it through the Snap Store using the following commands via the terminal. ``` $ sudo apt update $ sudo apt install snapd $ sudo snap install postman ``` +Alternatively, you can download and install it from the Snap Store itself. + +
+ +![](https://i.imgur.com/N6Svo2y.png)

This is the simplest way to install Postman on Linux/Ubuntu systems. + +
+ +### Setting up Postman for proper usage on Linux and Windows +
+ +*While these screenshots were taken in Windows, the process henceforth will be the same in a Linux environment.* + +
+ +* Create your account with all the required details, or you can also signup with Google, as shown in the image.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates4.png) + +* After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) + +* You will see the following page, and then you are ready to use Postman.
+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png)

### Steps to update the Postman desktop client +
+ * You will receive a notification in your Postman app if any update is available. * To download or install the latest update, click on the Settings icon, as shown in the image below, go to Settings>Update.

@@ -86,6 +92,10 @@ This is the simplest way to install Postman on Linux/Ubuntu systems. * It automatically downloads minor updates and bug fixes. +
+ +*Note that if you who install Postman in a Linux environment you may not have the* Check for updates *option. This is because the updates are handled by the snap store, which automatically updates Postman on a regular basis.* + From 7732219884a9d5b64caeeb8b2f67a72a6bc7748f Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sun, 9 Apr 2023 11:51:34 +0530 Subject: [PATCH 07/13] Made more edits and combined the installation and usage tutorials --- learning/dashboard/Group 4/Postman.md | 143 +++++++++++++++++++++++++ learning/dashboard/Group 4/Postman1.md | 106 ------------------ learning/dashboard/Group 4/README.md | 5 + learning/dashboard/Group 4/reademe.md | 31 ------ 4 files changed, 148 insertions(+), 137 deletions(-) create mode 100644 learning/dashboard/Group 4/Postman.md delete mode 100644 learning/dashboard/Group 4/Postman1.md create mode 100644 learning/dashboard/Group 4/README.md delete mode 100644 learning/dashboard/Group 4/reademe.md diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md new file mode 100644 index 00000000..301ba9d1 --- /dev/null +++ b/learning/dashboard/Group 4/Postman.md @@ -0,0 +1,143 @@ +# **Postman:** 101 + +
+ +![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) + +
+ +Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. Here are some of the reasons why Postman is used by over 8 million users today: + +- Accessibility: One can use it anywhere after installing Postman into the device by simply logging in to the account. +- Using Collections: Postman allows users to build collections for their API-calls. Every set can create multiple requests and subfolders. It will help to organize the test suites. +- Test development: To test checkpoints, verification of successful HTTP response status shall be added to every API-call. +- Automation Testing: Tests can be performed in several repetitions or iterations by using the Collection Runner or Newman, which saves time for repeated tests. +- Creating Environments: The design of multiple environments results in less replication of tests as one can use the same collection but for a different setting. +- Debugging: To effectively debug the tests, the postman console helps to track what data is being retrieved. +- Collaboration: You can import or export collections and environments to enhance the sharing of files. You may also use a direct connection to share the collections. +- Continuous integration: It can support continuous integration. +- Application development: Accelerated application development with Postman eliminates dependencies and reduces the time taken by production by having the frontend and backend teams work in parallel. + +This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. + +After completion of this tutorial, you will get a basic level of understanding of Postman and API testing. This tutorial will also give you a good understanding of how to use Postman to execute APIs for any given URL for your daily work. +
+
+ +## Installation, Setup and Updates + +
+ + Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. +
+
+ +### Downloading and installing the native Postman application on Windows + +
+ +* Go to this link (https://www.postman.com/downloads/) and click *Download* for Windows.

+![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png)
+ *For downloading the app for Windows, click on the download button and select the particular version. If you are using a 32-bit OS, you can choose the 32 bit option instead.* + +* You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates2.png)
+*It is preferable to create an account as this will help you to save the work you do within Postman, and with this, you won't lose any work.* +
+
+ +### Downloading and installing the native Postman application on Linux (Ubuntu) + +
+ +To install the latest version of the Postman desktop application, you can do so through the Snap Store using the following commands via the terminal. +``` +$ sudo apt update +$ sudo apt install snapd +$ sudo snap install postman +``` +Alternatively, you can download and install it within the Snap Store's UI. + +
+ +![](https://i.imgur.com/N6Svo2y.png)

+Either way, this is the simplest method to install Postman on Linux/Ubuntu systems. + +
+ +### Setting up Postman for proper usage on Linux and Windows + +*While these screenshots were taken in Windows, the process henceforth will be the same in a Linux environment.* + +
+ +* Create your account with all the required details, or sign up with Google, as shown in the image.

+![Javatpoint](https://i.imgur.com/UU6cI7m.png) + +* After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) + +* You will see the following page, and then you are ready to use Postman.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png) +
+
+ +### Steps to update the Postman desktop client + +
+ +* You will receive a notification in your Postman app if any update is available. + +* To download or install the latest update, click on the *Settings* icon, as shown in the image below, then go to *Update*.

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates7.png) + +* You can change the update settings by enabling the *Automatically download major updates* setting, as shown in the image below

+![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates8.png) + +* You can also check for the latest updates by clicking on *Check for updates*, which will show you if any new update is available. + +* You will have to select the update option to download and install the latest update. When the download is complete, you will see a notification asking you to restart the app to install the updated features. + +* It automatically downloads minor updates and bug fixes. + +
+ +*Note that if you install Postman in a Linux environment you may not have the* Check for updates *option. This is because the updates are handled by the snap store, which automatically updates Postman on a regular basis.* + +
+ +## Usage + +The following steps will show you how to use Postman after properly installing and setting it up. + +1. Open your Postman desktop application

+![](https://i.imgur.com/LRI7l6I.png) + +2. Open Postman and select *Workspaces*

+![](https://i.imgur.com/JFzKUuq.png) + +3. In the workspace section section, click on *New*

+![](https://i.imgur.com/mRfSIc4.png) + +4. After that, you will be greeted by a dialog box as seen below, click on *HTTP Request*

+![](https://i.imgur.com/1wAT25e.png) + +5. You will see an input box in the *GET* section as highlighted below, you will have to put your API key or JSON in this box.

+![](https://i.imgur.com/sRVBSoL.png)

+Then all you need to do is press the *Send* button + +6. You will then be greeted with the following json response message, typically look for *200 OK* for a successful response

+![](https://i.imgur.com/ZapU4PC.png) + +
+Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API. + + + + + + + + + + diff --git a/learning/dashboard/Group 4/Postman1.md b/learning/dashboard/Group 4/Postman1.md deleted file mode 100644 index 82ac0742..00000000 --- a/learning/dashboard/Group 4/Postman1.md +++ /dev/null @@ -1,106 +0,0 @@ -# Postman and it's usage - -
- -![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) - -
- -Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. - -This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. - -After completion of this tutorial, you will get a basic level of understanding of Postman and API testing. This tutorial will also give you a good understanding of how to use Postman to execute APIs for any given URL for your daily work. -
-
- -## Installation, Setup and Updates - -
- - Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. -
-
- -### Downloading and installing the native Postman application on Windows - -
- -* Go to the link https://www.postman.com/downloads/ and click download for Mac or Windows or Linux based on your operating system.

-![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png) - -* For downloading the app for Windows, click on the download button and select the particular version. I opted for the 64-bit version. If you are using a 32-bit OS, you can choose the 32 bit, as shown in the above image. - -* You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates2.png)

-It is better to create an account as this will help you to save the work you do within the Postman, and with this, you won't lose any work. -
-
- -### Downloading and installing the native Postman application on Linux (Ubuntu) - -
- -To install the latest version of the Postman desktop app, you need to install it through the Snap Store using the following commands via the terminal. -``` -$ sudo apt update -$ sudo apt install snapd -$ sudo snap install postman -``` -Alternatively, you can download and install it from the Snap Store itself. - -
- -![](https://i.imgur.com/N6Svo2y.png)

-This is the simplest way to install Postman on Linux/Ubuntu systems. - -
- -### Setting up Postman for proper usage on Linux and Windows -
- -*While these screenshots were taken in Windows, the process henceforth will be the same in a Linux environment.* - -
- -* Create your account with all the required details, or you can also signup with Google, as shown in the image.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates4.png) - -* After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) - -* You will see the following page, and then you are ready to use Postman.
-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png) -
-
- -### Steps to update the Postman desktop client - -
- -* You will receive a notification in your Postman app if any update is available. - -* To download or install the latest update, click on the Settings icon, as shown in the image below, go to Settings>Update.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates7.png) - -* You can change the update settings by enabling the settings of automatically download major updates, as shown in the image below

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates8.png) - -* You can also check for the latest updates by clicking on Check for updates, which will show you if any new update is available. - -* You will have to select the update option to download and install the latest update. When the download is complete, you will see a notification asking you to restart the app to install the updated features. - -* It automatically downloads minor updates and bug fixes. - -
- -*Note that if you who install Postman in a Linux environment you may not have the* Check for updates *option. This is because the updates are handled by the snap store, which automatically updates Postman on a regular basis.* - - - - - - - - - diff --git a/learning/dashboard/Group 4/README.md b/learning/dashboard/Group 4/README.md new file mode 100644 index 00000000..828d665a --- /dev/null +++ b/learning/dashboard/Group 4/README.md @@ -0,0 +1,5 @@ +## This tutorial on the basics of *Postman* was created by: +- Chrirag Kumar +- Asha E +- Dasari Lakshmi Nayarana +- Chris Daniel Wilson \ No newline at end of file diff --git a/learning/dashboard/Group 4/reademe.md b/learning/dashboard/Group 4/reademe.md deleted file mode 100644 index ea409cd0..00000000 --- a/learning/dashboard/Group 4/reademe.md +++ /dev/null @@ -1,31 +0,0 @@ -# Using Postman - -The following tutorial will show you how to use Postman after properly installing and setting it up. - -1. Open your Postman desktop application

-![](https://i.imgur.com/LRI7l6I.png) - -2. Open Postman and select "workspace"

-![](https://i.imgur.com/JFzKUuq.png) - -3. In workspace section section, click on new

-![](https://i.imgur.com/mRfSIc4.png) - -4. After that, you will be greeted by a dialog box as seen below, click on *HTTP Request*

-![](https://i.imgur.com/1wAT25e.png) - -5. You will see an input box in the Get section as highlighted below, you will have to put your API key or JSON in this box.

-![](https://i.imgur.com/sRVBSoL.png)

-Then all you need to do press the *Send* button - -6. You will then be greeted with the following json response message, typically look for *200 OK* for a successful response

-![](https://i.imgur.com/ZapU4PC.png) - -
-Provided you followed all the above steps properly, you have now successfully used Postman to get a postivie response from an API. - - - - - - From 42382b6a4f7ccf7cfaf15fc6dad57147b1975f7c Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sun, 9 Apr 2023 12:41:37 +0530 Subject: [PATCH 08/13] Added References --- learning/dashboard/Group 4/Postman.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index 301ba9d1..558cbe08 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -132,6 +132,19 @@ Then all you need to do is press the *Send* button
Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API. +
+
+ +--- +## References + +- https://www.postman.com +- https://www.postman.com/downloads/ +- https://www.javatpoint.com/postman-installation-and-updates +- https://learning.postman.com/docs/getting-started/installation-and-updates/ +- https://learning.postman.com/docs/getting-started/installation-and-updates/#installing-postman-on-linux +- https://en.wikipedia.org/wiki/Postman_(software) +- https://github.com/postmanlabs From 30860f9a7e414ca82d7d2749427c4f754af42d1f Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Sun, 16 Apr 2023 23:13:37 +0530 Subject: [PATCH 09/13] Added more info, still WIP --- learning/dashboard/Group 4/Postman.md | 192 ++++++++++++++++++++------ 1 file changed, 153 insertions(+), 39 deletions(-) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index 558cbe08..578901bc 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -2,7 +2,7 @@
-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-tutorial.png) +![](https://i.postimg.cc/G3NzwvKt/image-2023-04-14-172950620.png)
@@ -18,7 +18,7 @@ Postman is one of the most popular software testing tools which is used for API - Continuous integration: It can support continuous integration. - Application development: Accelerated application development with Postman eliminates dependencies and reduces the time taken by production by having the frontend and backend teams work in parallel. -This tutorial is created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. +This tutorial was created for those who would like to learn the basics of Postman. As the number of web and mobile applications is increasing, the importance of API testing is also growing. So this tutorial will help you to learn postman testing for testing APIs. After completion of this tutorial, you will get a basic level of understanding of Postman and API testing. This tutorial will also give you a good understanding of how to use Postman to execute APIs for any given URL for your daily work.
@@ -28,24 +28,25 @@ After completion of this tutorial, you will get a basic level of understanding o
- Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. -
+ > Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. +
### Downloading and installing the native Postman application on Windows
-* Go to this link (https://www.postman.com/downloads/) and click *Download* for Windows.

-![Javatpoint]( https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates.png)
- *For downloading the app for Windows, click on the download button and select the particular version. If you are using a 32-bit OS, you can choose the 32 bit option instead.* +* Go to [this link](https://www.postman.com/downloads/) and click *Download* for Windows.

+![](https://i.postimg.cc/HxGz8yZ3/image-2023-04-14-173433882.png)
+ *For downloading the app for Windows, click on the download button and select the particular version. If you are using a 32-bit OS, you can choose the 32 bit option instead.*

-* You can check the download progress on the bottom left if you are using the Chrome browser. Once the .exe file is downloaded, you need to install the application, as shown in the below image.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates2.png)
+* Once the .exe file is downloaded, you need to install the application.

+![](https://i.postimg.cc/Z5fmFTp1/image-2023-04-14-174101132.png)
*It is preferable to create an account as this will help you to save the work you do within Postman, and with this, you won't lose any work.*

+ ### Downloading and installing the native Postman application on Linux (Ubuntu)
@@ -60,25 +61,27 @@ Alternatively, you can download and install it within the Snap Store's UI.
-![](https://i.imgur.com/N6Svo2y.png)

+![](https://i.postimg.cc/FR2PvhH6/image-2023-04-14-175939859.png)

Either way, this is the simplest method to install Postman on Linux/Ubuntu systems.
### Setting up Postman for proper usage on Linux and Windows -*While these screenshots were taken in Windows, the process henceforth will be the same in a Linux environment.* +
+ +> *While these screenshots were taken in Windows, the process henceforth will be the same in a Linux environment.*
* Create your account with all the required details, or sign up with Google, as shown in the image.

-![Javatpoint](https://i.imgur.com/UU6cI7m.png) +![](https://i.postimg.cc/pXYpKkzh/image-2023-04-14-180114098.png) * After signing in, select the workspace tools as per your requirement, and then click on, continue to get the startup screen.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates5.png) +![](https://i.postimg.cc/Z5gr9Vrk/image.png) * You will see the following page, and then you are ready to use Postman.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates6.png) +![](https://i.postimg.cc/L8CMjZXF/image-2023-04-14-180739584.png)

@@ -89,10 +92,10 @@ Either way, this is the simplest method to install Postman on Linux/Ubuntu syste * You will receive a notification in your Postman app if any update is available. * To download or install the latest update, click on the *Settings* icon, as shown in the image below, then go to *Update*.

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates7.png) +![](https://i.postimg.cc/DfCbNxm9/image.png) -* You can change the update settings by enabling the *Automatically download major updates* setting, as shown in the image below

-![Javatpoint](https://static.javatpoint.com/tutorial/postman/images/postman-installation-and-updates8.png) +* You can change the update settings by enabling the *Automatically download major updates* setting, as shown in the image below.

+![](https://i.postimg.cc/ydLWwN6m/image.png) * You can also check for the latest updates by clicking on *Check for updates*, which will show you if any new update is available. @@ -106,31 +109,148 @@ Either way, this is the simplest method to install Postman on Linux/Ubuntu syste
-## Usage +## Basic Usage + +
+ +> The following steps will show you how to use Postman after properly installing and setting it up. Consider this a trial run if you are using Postman for the first time. -The following steps will show you how to use Postman after properly installing and setting it up. +
-1. Open your Postman desktop application

-![](https://i.imgur.com/LRI7l6I.png) +1. Open your Postman desktop application. -2. Open Postman and select *Workspaces*

-![](https://i.imgur.com/JFzKUuq.png) +2. Open Postman and select *Workspaces*.

+![](https://i.postimg.cc/tg9Y4cTC/image-2023-04-14-181343781.png) -3. In the workspace section section, click on *New*

-![](https://i.imgur.com/mRfSIc4.png) +3. In the workspace section section, click on *New*.

+![](https://i.postimg.cc/5Nx4vzJn/image-2023-04-14-181442008.png) -4. After that, you will be greeted by a dialog box as seen below, click on *HTTP Request*

-![](https://i.imgur.com/1wAT25e.png) +4. After that, you will be greeted by a dialog box as seen below, click on *HTTP Request*.

+![](https://i.postimg.cc/m2zs7yq3/image-2023-04-14-181637506.png) 5. You will see an input box in the *GET* section as highlighted below, you will have to put your API key or JSON in this box.

-![](https://i.imgur.com/sRVBSoL.png)

-Then all you need to do is press the *Send* button +![](https://i.postimg.cc/Kc79wkTX/image-2023-04-14-181725497.png) +*As you can see here we've used a JSON from a [crowdsourced database that tracked the coronavirus in India](https://data.covid19india.org).*

+Then all you need to do is press the *Send* button. -6. You will then be greeted with the following json response message, typically look for *200 OK* for a successful response

-![](https://i.imgur.com/ZapU4PC.png) +6. You will then be greeted with the following json response message, typically look for *200 OK* for a successful response.

+![](https://i.postimg.cc/V6fSNVKW/image-2023-04-14-181804701.png)
-Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API. +Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API. +

+ +## Intermediate Usage and Further Information + +
+ +> We will be using a [very simple API developed for books](https://github.com/vdespa/introduction-to-postman-course/blob/main/simple-books-api.md) for the following steps. This section will cover some slightly more advanced usage of Postman as well the explanation of endpoints, how variables work and environments. + +
+ +### Workspaces + +First off, you will need to create a workspace and get a request tab set up like earlier. + +- Go to *Workspaces* and click on new *Create Workspace*.

+![](https://i.postimg.cc/xdTKBJF9/image-2023-04-15-183439091.png)

+ +- Name your workspace and give it a meaningful summary. You can make your workspace personal, team-oriented, private, public or partner-oriented, but for now we'll just make it personal.

+![](https://i.postimg.cc/8zNcndJ0/image-2023-04-15-181839594.png) +![](https://i.postimg.cc/kMVDzXjW/image-2023-04-15-182657120.png)

+ +- On the left pane of your Postman window, click on *New*.

+![](https://i.postimg.cc/gkpKzYY5/image-2023-04-15-184331801.png)

+- Then click on *HTTP Request*.

+![](https://i.postimg.cc/x8vXCJv4/image-2023-04-15-184851721.png)

+ +This will make an untitled HTTP request as seen below.

+![](https://i.postimg.cc/j5Z7QJwn/image-2023-04-15-185020949.png)

+ +### Collections +To give your request a proper title you will have to save it to a collection, which is nothing but a compilation of requests. + +- Click the *Save* button in the top-right corner.

+![](https://i.postimg.cc/j5qFX54n/image-2023-04-15-190016719.png)

+- If this is your first time using Postman, you will likely not have any pre-existing collections to save your request to, so you will first have to make one. Click on *Create Collection*.

+![](https://i.postimg.cc/kMZN54zM/image-2023-04-15-190352931.png)

+- Give your collection a name.

+![](https://i.postimg.cc/fTT5rLpM/image-2023-04-15-190902284.png) +> Note that you can also do this by clicking the Collections tab, then clicking the '+' icon and renaming it if you wish +- You can now save your request to your newly created collection.

+![](https://i.postimg.cc/B6cZXsTn/image-2023-04-15-191211558.png) +![](https://i.postimg.cc/SNjTtVsS/image-2023-04-16-185153973.png)

+- Now copy and paste the link to the source of the API you're using, which in this case is `https://simple-books-api.glitch.me` for the simple book API.

+![](https://i.postimg.cc/527XZhqY/image-2023-04-15-200119592.png)

+This link, with the inclusion of any modifications made to it, is what's known as the **Request URL**. + +
+ +### Request methods +Let us now discuss what that `GET` beside the request URL means. The nature of HTTP requests allows to specify the context in which you are interacting with the API, i.e., whether your request URL will serve primarily as a request to the API to recieve an input or produce an output and furthermore what kind of input to take or output to give. To that effect there are several *Request methods* in Postman. The most commonly used ones are: + +1. GET +2. POST +3. PATCH +4. DELETE + +In Postman any request you create will use the `GET` method by default. The `GET` method is used to retrieve information from the API. Requests using this method should only retrieve data and should have no other effect on the data. The usage of the other methods will be explained later on through the course of this tutorial. + +
+ +### Endpoints +An endpoint is a URL pattern used to communicate with an API. It is essentially a way through which a user or an application can interact with other applications. For example, If you add `status` to the request URL to get `https://simple-books-api.glitch.me/status`, then that `status` you just added would become an endpoint for that link. + +
+ +Adding the `status` endpoint to the request URL beforing hitting *Send* would give you this output:

+![](https://i.postimg.cc/DyjZ7fnQ/image-2023-04-16-185429831.png) +*Notice the* Status: 200 OK *message* + +> Note that while some endpoints like `status` are common in most APIs, many more are specific to individual ones. + +The request URL as it is right now might look a little complicated, but it is possible to simplify it a bit through the use of variables. + +
+ +### Variables +Variables enable you to store and reuse values in Postman. By storing a value as a variable, you can reference it throughout your collections, environments and requests. Since `https://simple-books-api.glitch.me` is going to be a recurring base point for the Request URL, its value can simply be assigned to variable and reused later. + +- Select the base URL and then click *Set as variable*, then click on *Set as new variable*.

+![](https://i.postimg.cc/CM2HqHs9/image-2023-04-16-211324491.png) +![](https://i.postimg.cc/D0W2bKPJ/image-2023-04-16-211646429.png)

+ +- Specify the name and scope of your variable.

+![](https://i.postimg.cc/vTd99H64/image-2023-04-16-221248025.png)

+ As you can see there are three ways you can go about this.

+ +> `Global`
If you set your variable's scope to *Global* it can be referenced across every collection, request and test case you make in Postman. + +> `Environment`
If you set your variable's scope to *Active Environment*, it will referenced only in the currently active environment, more on this later. + +> `Collection`
If you set your variable's scope to *Collection*, it will be referenced only within the collection you're creating the variable in. + +
+ +- Choose *Collection* for now. *Global* would work similarly in this scenario though since you have made only one collection so far. + +- If you click on your collection and then navigate to *Variables* you should be able to see your variable

+![](https://i.postimg.cc/DzRhZVkp/image-2023-04-16-220916216.png)

+ +- Now replace `https://simple-books-api.glitch.me` in your request URL with the name you gave it in double curly braces, `{{base}}` in this case, and send the request again. It should work just as it did before.

+![](https://i.postimg.cc/q7tx3xLq/image-2023-04-16-222645809.png)

+ +Now that the request URL is a little easier to read, let's use another endpoint with the `GET` method. + +- The `books` endpoint will return a list of books

+![](https://i.postimg.cc/XJPf7GFF/image-2023-04-16-223022815.png)

+ +> *Query Parameters*
Query parameters are appended to the end of the request URL, following a '?' and are listed in key value pairs, separated by '&' using the following syntax: `?id=1&type=new` + +
+ +- This API allows you to use the `type` parameter after the `books` endpoint to specify whether you want fiction or non-fiction books. You can implement this either by following the general syntax and typing `?type=(fiction/non-fiction)` after the rest of the request URL or by simply adding the parameter more intuitively into the table provided the *Params* tab under the request URL.

+![](https://i.postimg.cc/MKz6pW03/image-2023-04-16-225327088.png)

@@ -146,11 +266,5 @@ Provided you followed all the above steps properly, you have now successfully us - https://en.wikipedia.org/wiki/Postman_(software) - https://github.com/postmanlabs +All the images used in this documentation are sourced from: https://postimg.cc/gallery/qdxZs8Q - - - - - - - From f5546746f069dbc78e10159a649f587894035d1e Mon Sep 17 00:00:00 2001 From: Chris Daniel Wilson <122552801+ChrisDanielW@users.noreply.github.com> Date: Mon, 17 Apr 2023 11:51:49 +0530 Subject: [PATCH 10/13] Recommiting for GPG key and verification --- learning/dashboard/Group 4/Postman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index 578901bc..53ac453c 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -26,7 +26,7 @@ After completion of this tutorial, you will get a basic level of understanding o ## Installation, Setup and Updates -
+
> Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. From 5c4059500067282fa407a48590dca6252a21ce41 Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Tue, 18 Apr 2023 23:27:56 +0530 Subject: [PATCH 11/13] Almost there, still WIP --- learning/dashboard/Group 4/Postman.md | 203 +++++++++++++++++++++----- 1 file changed, 169 insertions(+), 34 deletions(-) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index 578901bc..1400906e 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -37,12 +37,17 @@ After completion of this tutorial, you will get a basic level of understanding o
* Go to [this link](https://www.postman.com/downloads/) and click *Download* for Windows.

-![](https://i.postimg.cc/HxGz8yZ3/image-2023-04-14-173433882.png)
- *For downloading the app for Windows, click on the download button and select the particular version. If you are using a 32-bit OS, you can choose the 32 bit option instead.*

+![](https://i.postimg.cc/HxGz8yZ3/image-2023-04-14-173433882.png)

+ + > For downloading the app for Windows, click on the download button and select the particular version. If you are using a 32-bit OS, you can choose the 32 bit option instead. + +
* Once the .exe file is downloaded, you need to install the application.

-![](https://i.postimg.cc/Z5fmFTp1/image-2023-04-14-174101132.png)
-*It is preferable to create an account as this will help you to save the work you do within Postman, and with this, you won't lose any work.* +![](https://i.postimg.cc/Z5fmFTp1/image-2023-04-14-174101132.png)

+ +> It is preferable to create an account as this will help you to save the work you do within Postman, and with this, you won't lose any work. +

@@ -137,8 +142,10 @@ Then all you need to do is press the *Send* button. ![](https://i.postimg.cc/V6fSNVKW/image-2023-04-14-181804701.png)
+ Provided you followed all the above steps properly, you have now successfully used Postman to get a postive response from an API. -

+ +
## Intermediate Usage and Further Information @@ -148,7 +155,10 @@ Provided you followed all the above steps properly, you have now successfully us
-### Workspaces +### *Workspaces* +*Workspaces in Postman allow you to organize your work and even collaborate with team members on projects. You can group your projects together with the workspace you set up acting as a hub of related APIs, collections, environments, mocks, monitors, and other linked entities.* + +
First off, you will need to create a workspace and get a request tab set up like earlier. @@ -163,58 +173,72 @@ First off, you will need to create a workspace and get a request tab set up like ![](https://i.postimg.cc/gkpKzYY5/image-2023-04-15-184331801.png)

- Then click on *HTTP Request*.

![](https://i.postimg.cc/x8vXCJv4/image-2023-04-15-184851721.png)

- This will make an untitled HTTP request as seen below.

![](https://i.postimg.cc/j5Z7QJwn/image-2023-04-15-185020949.png)

-### Collections -To give your request a proper title you will have to save it to a collection, which is nothing but a compilation of requests. +### *Collections* +*Collections in Postman are essentially compilations of saved requests and variables. The latter is discussed further on.* + +
+ +To give your request a proper title you will have to save it to a collection. - Click the *Save* button in the top-right corner.

![](https://i.postimg.cc/j5qFX54n/image-2023-04-15-190016719.png)

- If this is your first time using Postman, you will likely not have any pre-existing collections to save your request to, so you will first have to make one. Click on *Create Collection*.

![](https://i.postimg.cc/kMZN54zM/image-2023-04-15-190352931.png)

- Give your collection a name.

-![](https://i.postimg.cc/fTT5rLpM/image-2023-04-15-190902284.png) -> Note that you can also do this by clicking the Collections tab, then clicking the '+' icon and renaming it if you wish +![](https://i.postimg.cc/fTT5rLpM/image-2023-04-15-190902284.png)

+> Note that you can also do this by selecting the Collections tab and clicking the '+' icon + +
+ - You can now save your request to your newly created collection.

![](https://i.postimg.cc/B6cZXsTn/image-2023-04-15-191211558.png) -![](https://i.postimg.cc/SNjTtVsS/image-2023-04-16-185153973.png)

+![](https://i.postimg.cc/SNjTtVsS/image-2023-04-16-185153973.png) +> Notice the orange dot next to your request tab. It is an indication that you haven't saved the tab since some work you did in. Make it a practise to frequently save your request tabs when working in Postman. - Now copy and paste the link to the source of the API you're using, which in this case is `https://simple-books-api.glitch.me` for the simple book API.

![](https://i.postimg.cc/527XZhqY/image-2023-04-15-200119592.png)

This link, with the inclusion of any modifications made to it, is what's known as the **Request URL**.
-### Request methods -Let us now discuss what that `GET` beside the request URL means. The nature of HTTP requests allows to specify the context in which you are interacting with the API, i.e., whether your request URL will serve primarily as a request to the API to recieve an input or produce an output and furthermore what kind of input to take or output to give. To that effect there are several *Request methods* in Postman. The most commonly used ones are: +### *Request methods* +*Let us now discuss what that `GET` beside the request URL means. The nature of HTTP requests allows to specify the context in which you are interacting with the API, i.e., whether your request URL will serve primarily as a request to the API to recieve an input or produce an output and furthermore what kind of input to take or output to give. To that effect there are several* Request methods *in Postman. The most commonly used ones are:* -1. GET -2. POST -3. PATCH -4. DELETE +*1.* *GET*
+*2.* *POST*
+*3.* *PATCH*
+*4.* *DELETE*
-In Postman any request you create will use the `GET` method by default. The `GET` method is used to retrieve information from the API. Requests using this method should only retrieve data and should have no other effect on the data. The usage of the other methods will be explained later on through the course of this tutorial. +*In Postman any request you create will use the `GET` method by default. The `GET` method is used to retrieve information from the API. Requests using this method should only retrieve data and should have no other effect on the data. The usage of the other methods will be explained later on through the course of this tutorial.*
-### Endpoints -An endpoint is a URL pattern used to communicate with an API. It is essentially a way through which a user or an application can interact with other applications. For example, If you add `status` to the request URL to get `https://simple-books-api.glitch.me/status`, then that `status` you just added would become an endpoint for that link. +### *Endpoints* +*An endpoint is a URL pattern used to communicate with an API. It is essentially a way through which a user or an application can interact with other applications. For example, If you add `status` to the request URL to get `https://simple-books-api.glitch.me/status`, then that `status` you just added would become an endpoint for that link.*
-Adding the `status` endpoint to the request URL beforing hitting *Send* would give you this output:

+Adding the `status` endpoint to the request URL beforing hitting *Send* would give you this output: +> Note that while some endpoints like `status` are common in most APIs, many more are specific to individual ones. + ![](https://i.postimg.cc/DyjZ7fnQ/image-2023-04-16-185429831.png) -*Notice the* Status: 200 OK *message* -> Note that while some endpoints like `status` are common in most APIs, many more are specific to individual ones. +> Notice the *200 OK* status message. If an error occurs due to the incorrect structuring of your request URL or anything else your output will look different to what is seen above and the status message will display *404 not found* or a variation of that. The request URL as it is right now might look a little complicated, but it is possible to simplify it a bit through the use of variables.
-### Variables -Variables enable you to store and reuse values in Postman. By storing a value as a variable, you can reference it throughout your collections, environments and requests. Since `https://simple-books-api.glitch.me` is going to be a recurring base point for the Request URL, its value can simply be assigned to variable and reused later. +### *Variables* +*Variables enable you to store and reuse values in Postman. By storing a value as a variable, you can reference it throughout your collections, environments and requests.* + +
+ +Since `https://simple-books-api.glitch.me` is going to be a recurring base point for the Request URL, its value can simply be assigned to variable and reused later. + +
- Select the base URL and then click *Set as variable*, then click on *Set as new variable*.

![](https://i.postimg.cc/CM2HqHs9/image-2023-04-16-211324491.png) @@ -222,7 +246,7 @@ Variables enable you to store and reuse values in Postman. By storing a value as - Specify the name and scope of your variable.

![](https://i.postimg.cc/vTd99H64/image-2023-04-16-221248025.png)

- As you can see there are three ways you can go about this.

+ As you can see, there are three ways you can go about this.

> `Global`
If you set your variable's scope to *Global* it can be referenced across every collection, request and test case you make in Postman. @@ -234,23 +258,133 @@ Variables enable you to store and reuse values in Postman. By storing a value as - Choose *Collection* for now. *Global* would work similarly in this scenario though since you have made only one collection so far. -- If you click on your collection and then navigate to *Variables* you should be able to see your variable

+- If you click on your collection and then navigate to *Variables* you should be able to see your variable.

![](https://i.postimg.cc/DzRhZVkp/image-2023-04-16-220916216.png)

-- Now replace `https://simple-books-api.glitch.me` in your request URL with the name you gave it in double curly braces, `{{base}}` in this case, and send the request again. It should work just as it did before.

+> You can also add a new collection scope variable by interacting with table above and specifiying the *initial value* + +- Now replace `https://simple-books-api.glitch.me` in your request URL with the name you gave it in double curly braces as per the general syntax, `{{base}}` in this case, and send the request again. It should work just as it did before.

![](https://i.postimg.cc/q7tx3xLq/image-2023-04-16-222645809.png)

Now that the request URL is a little easier to read, let's use another endpoint with the `GET` method. -- The `books` endpoint will return a list of books

+- The `books` endpoint when added to the request URL will return a list of books

![](https://i.postimg.cc/XJPf7GFF/image-2023-04-16-223022815.png)

-> *Query Parameters*
Query parameters are appended to the end of the request URL, following a '?' and are listed in key value pairs, separated by '&' using the following syntax: `?id=1&type=new` +### *Query Parameters* +*Query parameters are appended to the end of the request URL, usually following an endpoint and a '?', and are listed in key value pairs, separated by '&' using the following syntax in which `test` is a query parameter:* + +``` +/?test= +``` + +
+ +- This API allows you to use the `type` query parameter after the `books` endpoint to specify whether you want fiction or non-fiction books. You can implement this either by following the syntax and typing `?type=(fiction/non-fiction)` after the base of the request URL (which is saved as `base` here) or by simply adding the parameter more intuitively into the table provided in the *Params* tab under the request URL.

+![](https://i.postimg.cc/6pvWqpC2/image-2023-04-17-082257705.png)

+ +- You can also use multiple query parameters by separating them with an '&' in the request URL or by interacting with the table. For instance, we can use the `limit` query parameter to limit the book results produced by the API, in tandem with the `type` query parameter.

+![](https://i.postimg.cc/cHq0kSXv/image-2023-04-18-164304458.png)

+ +### *Path Variables* +*You can use Path Variables with your endpoints to add more specificity to your requests. They work differently from query parameters and follow the follwing syntax where `test` is a path variable.* +``` +/:/test +``` +*You cannot directly assign values to path variables in the request URL.* + +
+ +- Using the `bookId` with the `books` endpoint will bring up detailed information the book whose ID is the same as `bookId`'s value. You can assign that value using the path variable table under *Params*.

+![](https://i.postimg.cc/8Cw2Y647/image-2023-04-18-174254756.png) + + +Let's move on to another request method. The `POST` request method is used to send data to the server, for example, customer information, file uploads, etc. using HTML forms. While `GET` so far was used to get an output, `POST` will be used to give input. + +- Make a new request by opening a new request tab and saving the new request to the collection you were working in previously. This step isn't necessary but it helps disambiguate requests a little since we're using different request methods.

+![](https://i.postimg.cc/0283hqcz/image-2023-04-18-180738572.png)

+![](https://i.postimg.cc/RZ0wkgk1/image-2023-04-18-180834599.png)

+![](https://i.postimg.cc/cCCKJBYq/image-2023-04-18-182414731.png)

+ +- Change the request method beside the request URL from `GET` to `POST` in the new request tab. + +Some APIs will require you to register your API client (Postman in this case) in order to use the functionality of certain endpoints. Upon properly registering your API client you will be given an access token to that effect. + +- Add your base URL variable and the `api-clients` endpoint to the request URL

+![](https://i.postimg.cc/GpRM78RZ/image-2023-04-18-192652708.png)

+ +- Click the *Body* tab under the request URL, then select *raw* and specify the body as *JSON*

+![](https://i.postimg.cc/W4DM7sFQ/image-2023-04-18-192845921.png)

+The [Book API's guide](https://github.com/vdespa/introduction-to-postman-course/blob/main/simple-books-api.md#api-authentication) suggests the following syntax while sending your credentials in JSON format. +``` +{ + "clientName": "name", + "clientEmail": "name@example.com" +} +``` +This code in JSON format constitutes the **request body**. Any special input sent to an API is sent through the request body.
-- This API allows you to use the `type` parameter after the `books` endpoint to specify whether you want fiction or non-fiction books. You can implement this either by following the general syntax and typing `?type=(fiction/non-fiction)` after the rest of the request URL or by simply adding the parameter more intuitively into the table provided the *Params* tab under the request URL.

-![](https://i.postimg.cc/MKz6pW03/image-2023-04-16-225327088.png) +- Follow the syntax by providing a name and corresponding email address and hit *Send*. You will receive an access token.

+> The text you entered in +![](https://i.postimg.cc/sxtXsRDZ/image-2023-04-18-193110014.png) +> Notice the different status message. + +The API will provide you (your current credentials) with an access token only **once**, meaning that if you try to repeat the previous steps you will be met with an error message. So it is recommeded that you save the access token as a variable immediately. + +- Copy the value of the access token (without the quotes), then navigate to your colelction, enter it as a variable and name it. Save your collection after doing so.

+![](https://i.postimg.cc/9FN21tCL/image-2023-04-18-204203978.png) +> Leave your *initial value* as `---` here. The initial value of a variable is usually visible to all clients in a public API and in most cases it is not advisable to make sensitive information like your access token public. + +- Go back to your previous request tab, and navigate to *Authorization*. Change the *Type* to *Bearer Token* in the drop-down menu.

+![](https://i.postimg.cc/Rhvmb4sm/image-2023-04-18-205613211.png)

+ +- Assign the access token variable you created earlier to the the value of *Token*. Save after doing so.

+![](https://i.postimg.cc/RVZ0dLJY/image-2023-04-18-210027905.png)

+ +Now that we've set up our access token, we can use another endpoint with the `POST` method. + +- Now use the `orders` endpoint to order a book, following the syntax as seen in the image.

+![](https://i.postimg.cc/h41xqd68/image-2023-04-18-214341800.png)

+If you use the same endpoint with the `GET` request method you should be able to see a summary of your order.

+![](https://i.postimg.cc/C1d4Ly6g/image-2023-04-18-215220668.png) +> Note that if you use a different request tab to do this you will again have to update the *Bearer Token* under *Authorization* with your access token variable for that request tab. + +
+ +We will now look at the `PATCH` request method. The `PATCH` request method is essentially used to update partial resources. For instance, when you only need to update one field of the resource, inputting a complete resource representation via `PUT` might be cumbersome and utilize more bandwidth than a simple `PATCH` request.

+ +- Create a new request tab, give it a meaningful name, and then save it to your collection like you did with the previous one. Change the request method to `PATCH` and add your base URL's variable to the request URL. Also set up the bearer token like you did in the previous tab. + +- When used in the `PATCH` method, the `orders` endpoint along with the `orderId` path variable can be used to update an existing order, namely by just changing the customer name. You will need the ID of the order made previously to carry out this request so either send a `GET` request with the `orders` and copy it from the output, or just copy it from the tab you just finished that request in.

+![](https://i.postimg.cc/vZncVY6H/image-2023-04-18-223709550.png)

+ +- Update the path variable for `orderId` under *Params* with the order ID you just copied.

+![](https://i.postimg.cc/PrqpQSyL/image-2023-04-18-224919588.png)

+ +- Navigate to *Body*, set to *raw* and change it's format to *JSON*. Then update it your order by changing the customer name and hit *Send*.

+![](https://i.postimg.cc/BnxQHzkf/image-2023-04-18-225531804.png)

+If you use `orders` with `GET` again, you will be able to see the change you just made.

+![](https://i.postimg.cc/5y7st185/image-2023-04-18-230043700.png) + +Lastly, let's use the `DELETE` method to delete the order we just made. The `DELETE` request method is used to delete specified resources. + +- Create another request tab, name it, save it to your collection and set up the *Bearer Token*. + +- When used in the `DELETE` method, the `order` endpoint with the `ordersId` path variable can be used to delete an existing order. You will need the ID of the order to do this. + +> Notice how the same endpoint has had different use cases across different request methods. + +- Specify `orderId`'s value under *Params* and hit *Send*

+![](https://i.postimg.cc/g2W64bDc/image-2023-04-18-232248749.png) + +> Unlike in `POST` and `PATCH`, you will not need to include or specify a request body in this request. + +- As you can see here, from sending a `GET` request with the `orders` endpoint, the order has been deleted.

+![](https://i.postimg.cc/g2W64bDc/image-2023-04-18-232248749.png)

+ +Provided you followed this section properly you should now a have better understanding of the usage of Postman

@@ -262,7 +396,8 @@ Now that the request URL is a little easier to read, let's use another endpoint - https://www.postman.com/downloads/ - https://www.javatpoint.com/postman-installation-and-updates - https://learning.postman.com/docs/getting-started/installation-and-updates/ -- https://learning.postman.com/docs/getting-started/installation-and-updates/#installing-postman-on-linux +- https://learning.postman.com/docs/getting-started/creating-the-first-collection +- https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces - https://en.wikipedia.org/wiki/Postman_(software) - https://github.com/postmanlabs From c07af327cf2afc7de5d5dd556300e703d311c529 Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Tue, 18 Apr 2023 23:32:38 +0530 Subject: [PATCH 12/13] 90% of the way there --- learning/dashboard/Group 4/Postman.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index a95fcf69..1400906e 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -26,7 +26,7 @@ After completion of this tutorial, you will get a basic level of understanding o ## Installation, Setup and Updates -
+
> Postman can be downloaded for all major operating systems, including Mac, Linux, and Windows, as a native app (standalone application). Postman is also available as a chrome extension application, but it is preferable to install and use the native desktop app because the extension does not support all the features that the native app has. From 040bc29151114bd687f6025fc14d99d2bbc7fe0c Mon Sep 17 00:00:00 2001 From: ChrisDanielW Date: Wed, 19 Apr 2023 12:07:55 +0530 Subject: [PATCH 13/13] Reworked tutorial; Added information on request methods, endpoints, environments, variables, query paramters and path variables --- learning/dashboard/Group 4/Postman.md | 34 ++++++++++++++++++--------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/learning/dashboard/Group 4/Postman.md b/learning/dashboard/Group 4/Postman.md index 1400906e..780e6249 100644 --- a/learning/dashboard/Group 4/Postman.md +++ b/learning/dashboard/Group 4/Postman.md @@ -6,7 +6,7 @@
-Postman is one of the most popular software testing tools which is used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. Here are some of the reasons why Postman is used by over 8 million users today: +Postman is one of the most popular software testing tools used for API testing. With the help of this tool, developers can easily create, test, share, and document APIs. Here are some of the reasons why Postman is used by over 8 million users today: - Accessibility: One can use it anywhere after installing Postman into the device by simply logging in to the account. - Using Collections: Postman allows users to build collections for their API-calls. Every set can create multiple requests and subfolders. It will help to organize the test suites. @@ -327,23 +327,34 @@ This code in JSON format constitutes the **request body**. Any special input sen
- Follow the syntax by providing a name and corresponding email address and hit *Send*. You will receive an access token.

-> The text you entered in ![](https://i.postimg.cc/sxtXsRDZ/image-2023-04-18-193110014.png) > Notice the different status message. The API will provide you (your current credentials) with an access token only **once**, meaning that if you try to repeat the previous steps you will be met with an error message. So it is recommeded that you save the access token as a variable immediately. -- Copy the value of the access token (without the quotes), then navigate to your colelction, enter it as a variable and name it. Save your collection after doing so.

-![](https://i.postimg.cc/9FN21tCL/image-2023-04-18-204203978.png) +### *Environments* +*An environment is a set of variables that you can use in your Postman requests. You can use environments to group related sets of values together and manage access to shared Postman data if you are working as part of a team.* + +Since your access token is sensitive data, we can assign the same to a variable in an environment. You will have to make an environment for this. + +- Navigate to *Environments* and click on the '+' icon, or click on *Create Environment*. Give your new environment a name

+![](https://i.postimg.cc/NfRSd2m3/image-2023-04-19-113613571.png) +![](https://i.postimg.cc/0j7f8mCD/image-2023-04-19-113925040.png)

+ +- Now copy the value of the access token (without the quotes), then enter it as a variable in your environment using the table and save it.

+![](https://i.postimg.cc/pXPBzsYn/image-2023-04-19-114537404.png) > Leave your *initial value* as `---` here. The initial value of a variable is usually visible to all clients in a public API and in most cases it is not advisable to make sensitive information like your access token public. - Go back to your previous request tab, and navigate to *Authorization*. Change the *Type* to *Bearer Token* in the drop-down menu.

![](https://i.postimg.cc/Rhvmb4sm/image-2023-04-18-205613211.png)

-- Assign the access token variable you created earlier to the the value of *Token*. Save after doing so.

-![](https://i.postimg.cc/RVZ0dLJY/image-2023-04-18-210027905.png)

+- Set your environment as *active* by hovering over your environment in the *environments* pane and clicking the tick mark, or by changing the value in the drop down menu in the top right corner from *No environment* to the name that you gave your environment.

+![](https://i.postimg.cc/fTVsvfvB/image-2023-04-19-115029189.png)

+ +- Now navigate to your current request tab and go to *Authorization*. Change the value of *type* to *Bearer Token*, then assign to *Token* the variable you created just now in double curly braces.

+![](https://i.postimg.cc/B6YYQ6vN/image-2023-04-19-120224052.png)

-Now that we've set up our access token, we can use another endpoint with the `POST` method. +Now that we've set up our environment and our access token, we can use another endpoint with the `POST` method. - Now use the `orders` endpoint to order a book, following the syntax as seen in the image.

![](https://i.postimg.cc/h41xqd68/image-2023-04-18-214341800.png)

@@ -363,7 +374,7 @@ We will now look at the `PATCH` request method. The `PATCH` request method is es - Update the path variable for `orderId` under *Params* with the order ID you just copied.

![](https://i.postimg.cc/PrqpQSyL/image-2023-04-18-224919588.png)

-- Navigate to *Body*, set to *raw* and change it's format to *JSON*. Then update it your order by changing the customer name and hit *Send*.

+- Navigate to *Body*, set to *raw* and change it's format to *JSON*. Then update your order by changing the customer name and hit *Send*.

![](https://i.postimg.cc/BnxQHzkf/image-2023-04-18-225531804.png)

If you use `orders` with `GET` again, you will be able to see the change you just made.

![](https://i.postimg.cc/5y7st185/image-2023-04-18-230043700.png) @@ -374,17 +385,17 @@ Lastly, let's use the `DELETE` method to delete the order we just made. The `DEL - When used in the `DELETE` method, the `order` endpoint with the `ordersId` path variable can be used to delete an existing order. You will need the ID of the order to do this. -> Notice how the same endpoint has had different use cases across different request methods. +> Notice how the endpoint `orders` has had multiple use cases across different request methods. - Specify `orderId`'s value under *Params* and hit *Send*

![](https://i.postimg.cc/g2W64bDc/image-2023-04-18-232248749.png) > Unlike in `POST` and `PATCH`, you will not need to include or specify a request body in this request. -- As you can see here, from sending a `GET` request with the `orders` endpoint, the order has been deleted.

+- As you can see here, from sending a `GET` request with the `orders` endpoint, the order you made just now has been deleted.

![](https://i.postimg.cc/g2W64bDc/image-2023-04-18-232248749.png)

-Provided you followed this section properly you should now a have better understanding of the usage of Postman +Provided you followed this section properly, you should now have a better understanding of the usage of Postman.

@@ -398,6 +409,7 @@ Provided you followed this section properly you should now a have better underst - https://learning.postman.com/docs/getting-started/installation-and-updates/ - https://learning.postman.com/docs/getting-started/creating-the-first-collection - https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces +- https://learning.postman.com/docs/sending-requests/managing-environments - https://en.wikipedia.org/wiki/Postman_(software) - https://github.com/postmanlabs