DEV Community: TaheraFirdose

Payload Creation using Org.Json Library - Part 7

TaheraFirdose — Sat, 16 Oct 2021 14:19:01 +0000

In this blog we will learn how to create Payload using Org.json library and will see three different flows as below

Sending simple payload
Sending complex payload
Sending payload using Array

JSON, as you know, is nothing more than a data representation using Object and Array. As a result, we can also construct payloads using the JSONObject and JSONArray classes. To use this feature, however, you must include the org.json library in your project. To obtain the org.json library, include this dependency in your project.

Steps:

1.Create an object of the JSONObject class, in our case we create data Object and we will be assigning the values using put method.

Important Note:

It is important to note that we must first convert the object of the JSONObject class to a string before passing it to the body method.

To assign the values, we'll use the put() method. It should not be confused with a PUT Http request. Both of these are distinct from one another

2.We are going to add below json.

3.Create a class PostRequest_Simple_OrgJSON.java and add the below code.

The org.json.simple package includes a class called JSONObject. This class represents a JSON string programmatically. Take a look at the Request JSON above; you'll note that it contains numerous nodes. The JSONObject.put(String, String) method can be used to add each node. After you've added all of the nodes, use the JSONObject.toJSONString() function to acquire the String representation of JSONObject.

we will simply add the JSON String to the body of the HTTP Request and make sure that the Content-Type is json.

4.Start the Json Server and the resource URI’s will be created as per the structure of the file:

5.Run the program and verify the results in the output window:

6.Verify the result in the db.json file. Open the file in Notepad and double-check the data posted by the above program.

7.The same can also be viewed in browser for the Items.

Sending Complex Json using Org.json:

Complex json is nested json or we can say its a json within a json. Below is the example of how complex json looks like.

Steps:

1.Create an object of the JSONObject class, in our case we create data Object for main json and childObject for nested json and we will be assigning the values using put method.

2.Start the Json Server and the resource URI’s will be created as per the structure of the file

3.Run the program and verify the results in the output window:

4.Verify the result in the db.json file. Open the file in Notepad and double-check the data posted by the above program.

5.The same can also be viewed in browser for the Items.

Sending Json in Array form using Org.json:

In the below json we can see we have main json and a nested json. The nested json consist of an array.

1.Create an object of the JSONObject class, in our case we create dataObject for main json and childJson for nested json . Since topping consist of array we will create three array objects arrayOne, arrayTwo, arrayThree and we will be assigning the values using put method.

2.Start the Json Server and the resource URI’s will be created as per the structure of the file.

3.Run the program and verify the results in the output window:

4.Verify the result in the db.json file. Open the file in Notepad and double-check the data posted by the above program.

5.The same can also be viewed in browser for the Items.

Multiple ways to send Payload - Part 6

TaheraFirdose — Thu, 16 Sep 2021 06:38:56 +0000

In this blog, we are going to discuss more about POST request testing and automation using RestAssured. Request Body parameter is also called payload. In our previous blog we saw how to send payload as strings.

There are three ways to send json payload.

Using Json File
Using Org.JSON
Using POJO

In this tutorial we will learn about passing json data as a file.

Pass JSON file as payload

Create a .json file in “src/test/resources” folder and write payload in that.

Mention this file location using the File class in Java. Your file object will look like this:

File jsonData = new File(“src\test\resources\jsondemo.json”)

Below is the post request:

Below is the output after code execution:

Creating Payload as JSON Object:

So here's the code and explanation for converting above JSON to JSONObject.

Now we need to pass the json object in the body as shown below:

How to send POST Request in Rest Assured - Part 5

TaheraFirdose — Wed, 08 Sep 2021 05:45:26 +0000

In the previous blog, we covered the basic terminology that we will be using during rest assured testing. We also learned how to setup Rest Assured JAR or maven dependency in our project.

Rest Assured supports all the HTTP methods like GET, POST, PUT and DELETE. Here GET stands for Read operation, POST stands for Write operation, PUT stands for Update operation and DELETE stands for Delete operation.

Once you have the import of REST Assured set up, add the following static imports to your test class:

import static io.restassured.RestAssured.;
import static org.hamcrest.Matchers.;

Now let's look at an example of POST Request using Rest Assured

1.Set URI:

First we need to set the base uri of our api.. The base url without the resource is represented by uri. In our case, the full url is http://localhost:3000/comments, and the uri is http://localhost:3000/, with comment as the rescue name.

2. Call post method

In the post method, we begin with the Given method and specify the data to be added as a String in the body method. We simply add a check ‘contentType(ContentType.JSON)‘ to make sure that the response we get is in JSON format and under POST method we specify the path '/comment'

3.Validate Response Code

Validating http status code of the response is quite easy using Rest Assured. The method statusCode() takes an integer as input and validate against the response code. If the status code is not matching with the actual one, then the test case will fail. Any validation we want to perform can be written after .then().

4.Rest Assured – Validate Response Content

Validating response content from the JSON response is quite easy using rest assured. Check below the way we are validating the comment from the JSON response.
Here the function body takes 2 parameters. First one is the path to the field which we want to validate. In this case, it is the comment. Here we are using org.hamcrest.CoreMatchers.equalTo() method as well to compare the content against expected response. Also notice that we have combined the status code validation and response body validation together.

5. Number Validation Using Rest Assured

We can use the same equalTo method to validate numbers as long as they are integers.

Below is the output after code execution

Rest Assured E2E Testing - Part 4

TaheraFirdose — Sun, 05 Sep 2021 16:19:36 +0000

Understanding HTTPS methods, status codes and syntax

What is HTTP?

The Hypertext Transfer Protocol (HTTP) is an application-level protocol for distributed, collaborative, hypermedia information systems. This is the foundation for data communication for the World Wide Web (i.e. internet) since 1990. HTTP is a generic and stateless protocol which can be used for other purposes as well using extensions of its request methods, error codes, and headers.

In Simple, HTTP works as a request-response protocol between a client and server.

Different Types of HTTP Methods:

GET:

GET requests should only be used to retrieve resource representation/information – not to modify it in any way. Because GET requests do not alter the state of the resource, they are considered safe methods.
For any given HTTP GET API, if the resource is found on the server, then it must return HTTP response code 200 (OK) – along with the response body, which is usually either XML or JSON content (due to their platform-independent nature).

POST:

A POST request is used to create a new resource into the collection of resources.
If a resource is created on the origin server, the response SHOULD be HTTP response code 201 (Created) and include an entity that describes the status of the request and refers to the new resource, as well as a Location header.

PUT:

PUT APIs are primarily used to update existing resources (if the resource does not exist, then API may decide to create a new resource or not). If the PUT API creates a new resource, the origin server MUST notify the user agent via the HTTP response code 201 (Created), and if an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to indicate successful request completion.

DELETE

DELETE APIs, as the name implies, are used to delete resources (identified by the Request-URI).
A successful response of DELETE requests SHOULD be HTTP response code 200 (OK) if the response includes an entity describing the status, 202 (Accepted) if the action has been queued, or 204 (No Content) if the action has been performed but the response does not include an entity.

PATCH

PATCH requests are used to perform a partial update on a resource. PUT requests also modify a resource entity, so to be clear – the PATCH method is the correct choice for partially updating an existing resource, and PUT should only be used if you are completely replacing a resource.

HTTP Response codes

The HTTP response codes are divided broadly in five categories :
• 1xx – Informational codes
• 2xx – Success codes
• 3xx – Redirect codes
• 4xx – Client error codes
• 5xx – Server error codes

Some of the most common HTTP response codes used with REST are as follows :

•200 (OK): This response code indicates that the request was made successfully.
•201 (Created): This response code indicates that request was successful and a resource was created. It is used to confirm success of a PUT or POST request.
•400 (Bad Request) : This code indicates that the data is in incorrect format.
•401 (Unauthorized) : This code indicates an authentication error.
•405 (Method Not Allowed) : This code indicates that HTTP method used is not supported for this resource.
•409 (Conflict) : This code indicates that there is a conflict request to create the same resource twice.
•404 (Not Found) :This code indicates that the required resource could not be found.
•500 (Internal Server Error) : This code indicates that there is some error on Server side.

What is Payload?

The body of your request and response message is the Payload of an API Module. It holds the information that you send to the server when you make an API request. Payload can be sent and received in a variety of formats, including JSON.

JSON Syntax Rules

• Data is in name/value pairs
• Data is separated by commas
• Curly braces hold objects
• Square brackets hold arrays

WHAT is JSON?

JSON stands for JavaScript Object Notation and it is lightweight format for storing and transporting data and is often used when data is sent from a server to a web page.

Below is the sample JSON File.

What Is XML?

XML stands for extensible Markup Language. It plays an important role in many different IT systemsand is often used for distributing data over the Internet.

Below is the sample XML File.

Rest Assured is one of the most powerful libraries for testing RESTful API using Java language. This should be the first-choice when you need to test a REST. All tests should be written in the BDD (Behavior Driven Development) format and its framework syntax is very clean and easy to use. The framework sends a network request to an application under test and verifies the response based on the expectations.

Let’s have a look at REST-Assured Syntax:

Let's try to understand the above code:

In the above example, no method has been passed to ‘given.' It means that there are no specific prerequisites.
There is a ‘get' method that is passed to ‘when,' and it indicates that an event occurs when we visit the URL specified in the ‘get' method.
When we hit the URL in ‘when', ‘then‘, we will receive output as a response, and then we will validate it. In this example, as shown in the above image, we are performing an assertion on the status code.

Rest Assured E2E Testing - Part 3

TaheraFirdose — Sun, 05 Sep 2021 13:05:58 +0000

Setup A Basic REST Assured Maven Project In Eclipse IDE

In this post we will learn to setup a Maven – REST Assured in Eclipse IDE.

Pre-requisites

To begin your project, you must have the following installed and configured on your computer.
Java and Eclipse IDE •
TestNG which is unit testing framework •
Maven (either we can add jar file manually to our project or we can create a maven project)

Lest’s get started with creating the project.

Creating Maven Project in Eclipse

Open eclipse and click on File> New> Project
In the wizard text box, type Maven and then select Maven from the list box, as shown below. Click the Next> button.

Click on Next button(select maven-archetype-quickstart)
Type in the Group Id and Artifact Id (You can give any name to that) and click Finish button
Finally, the Maven Project “RESTAssured_APITesting” is successfully created. Please keep in mind that this Maven project generates pom.xml, as highlighted and shown below.
Add dependency of rest assured in pom.xml. For getting maven dependency, visit Maven Repository.
Add Maven dependency of TestNG/Junit in your framework. These tests framework will help in managing tests. TestNG is preferable as compared to Junit because of additional features in TestNG. You can copy the dependency from Maven Repository and then paste it in pom.xml.

Add Maven dependency of Jackson JSON java parser and JSON Schema Validator in pom.xml. JSON Schema Validator will be used to validate JSON Schema while JSON java parser will be used for parse JSON to map java objects to and from JSON.

Install hamcrest Assertion
After adding all the dependencies, the final pom.xml will look just like below.
After successful addition of dependencies, you will see JAR files in Maven dependencies in your project structure.

Rest Assured E2E Testing - Part 2

TaheraFirdose — Sun, 05 Sep 2021 12:56:14 +0000

How to create a Fake REST API with JSON-Server

We currently do not have any real business exposed APIs with us for testing, so we will be creating dummy APIs (which will be provided by the developers in the real time scenario) using NodeJS. The npm package in Node JS will help us even more by installing JSON Server, which will allow us to create dummy APIs for practise.
To install Json server, first install nodejs and npm (npm is installed automatically when we install nodejs).

Installation and Configuration of NodeJS:

Go to google.com and search “download Node JS
Download Node.js from the link https://nodejs.org/en/download/
Select the installer based on your system, I am downloading
windows installer
After successfully downloading, install by clicking next -> next -> next till finish
The nodejs setup can be found in the nodejs folder, which is usually created by default at C:\Program Files\nodejs. Start the setup. Copy the path C:\Program Files\nodejs from the nodejs folder.

Now set up the path variables as shown below
In the search bar, enter sys and select Edit the system environment variables.
Click on Advanced tab and Environment variables
Under system Variables, click on new and add as below
Select Path Variable under the System variables and click on Edit Button
Click on New and Paste the path that was copied earlier in step 5 C:\Program Files\nodejs and click Ok…Ok and Ok.
Verify the installation in command prompt by entering node -v
Please note that after installing nodejs, another file named npm (node package manager) is installed under the nodejs folder, and this npm facilitates the installation of various nodejs packages.
verify npm installation by typing the following command: C:>npm - -version

Installing Json Server

JSON Server is available as a NPM package. The installation can be done by using the Node.js package manager:

$ npm install -g json-server

By adding the -g option we make sure that the package is installed globally on your system.

JSON File

Let's make a new JSON file called db.json. This file contains the data that the REST API should expose. CRUD entpoints are automatically created for objects contained in the JSON structure. Take a look at the sample db.json file below:

Running The Server

Let’s start JSON server by executing the following command:

$ json-server --watch db.json

As a parameter, we must supply the file containing our JSON structure (db.json). In addition, we're employing the — watch parameter. By using this parameter, we ensure that the server is started in watch mode, which means that it monitors for file changes and updates the exposed API as needed.

The json server is up and it has created four dumpy API’s for us as per the json data present in file:
• http://localhost:3000/employees
• http://localhost:3000/posts
• http://localhost:3000/comments
• http://localhost:3000/profile

Now we can open URL http://localhost:3000 in the browser and we’ll get to see below result.

To terminate the server we have to type Ctrl+C command and then press Y as per confirmation message prompted below

Rest Assured E2E Testing - Part 1

TaheraFirdose — Sun, 05 Sep 2021 12:45:59 +0000

API Testing Process Using REST Assured

APIs enable risk-free legacy modernization and drive businesses toward digital transformation. APIs must be precisely optimised to meet a specific business request in a specific context. API testing is the key to success in ensuring a robust API. API testing can be done manually using POSTMAN tools or automatically using Rest Assured dependency code. We'll talk about API testing with REST Assured in this section.

What is REST Assured?

Rest Assured is a Java-based library for testing RESTful Web Services. The fact that this is a Java-based library of course does not matter because REST Assured is based only on JSON and HTTP . These are language-independent, we can use REST Assured to create tests for applications written in any language. To access REST web services, this library acts as a headless client. In just one line, we can create a complex HTTP request.
REST Assured also provides us with a lot of validations to our requests, such as for example Status Code, Status Response, Headers, or even Body response. This means that the library is really flexible when it comes to testing.

Advantages of Rest Assured

Open source, and hence, it is free of any license cost
Based on Java
Offers support for all kinds of HTTP methods like POST, GET, PUT, DELETE, OPTIONS, PATCH and HEAD
Supports both path and query parameters
Supports the BDD/Gherkin style of writing, which supports clean coding & enhances readability
Enables easy integration with classic testing & reporting frameworks such as TestNG, JUnit runner and Allure Report
One can test an application written in any language like Java, .Net, Python, Ruby, etc.
JSON schema validation can be performed
Makes it easy to test and validate REST services in the Java domain which is usually tough
Now let us look at how we an perform API testing with the help of REST Assured.

Disadvantages of Rest assured

Requires knowledge of the Java programming language.
Does not support SOAP APIs explicitly.

Git CheatSheet

TaheraFirdose — Sat, 28 Aug 2021 07:07:18 +0000

This guide includes an introduction on Git, a definition of terms, and lists of commonly used Git commands. If you're having trouble getting started with Git, or if you're an experienced tester looking for a refresher, this cheat sheet can help.

What is GIT

Git is a free, open source distributed version control system tool designed to handle everything from small to very large projects with speed and efficiency. It was created by Linus Torvalds in 2005 to develop Linux Kernel. Git has the functionality, performance, security and flexibility that most teams and individual developers and testers need. It also serves as an important distributed version-control DevOps tool.

Git Terminologies:

Repositories

Repositories can be compared to folders on your computer. A Github repository contains all of the project's files, including the documentation and all revisions. It is the most basic element of
Github.

Branch:

Branch is a version of the repository that diverges from the main working project. It is an essential feature available in most modern version control systems. A Git project can have more than one branch. We can perform many operations on Git branch-like rename, list, delete, etc

Remote:

Remote is the term used to refer to the repository hosted in Github. A company's local Git repository hosted in Github or any other Git host platform for sharing and collaboration is generally called Remote repository.

Master

The master is the primary branch of all your repositories. It should include the most recent changes and commits.

Checkout

Use the git checkout command to switch between branches. Just enter git checkout followed by the name of the branch you wish to move to, or enter git checkout master to return to the master branch.

Commit

Commit is one the most frequently used feature of Git, it’s like saving the updated file to its original folder and overwrite on already existing.A commit is a collection of content, a message about how you got there, and the commits that came before it.

Fetch

Fetching refers to getting the latest changes from an online repository (like GitHub.com) without merging them in. Once these changes are fetched you can compare them to your local branches (the code residing on your local machine).

Fork

A 'fork' is a personal copy of another user's repository on your GitHub account. Forks allow you to freely modify a project without affecting the original, providing limitless opportunities for experimentation and learning from the work of others.

Head

A HEAD is a snapshot of the most recent commit on each branch. On each branch, it is a short name or a pointer reference to a SHA-1 of a commit ID.A HEAD always points to the branch's most recent commit (code) and moves forward with each commit to point to the most recent commit ID.

Index

When you add, delete, or modify a file, it is retained in the index until you are ready to commit the changes. Think of it as Git's staging area. To view the contents of your index, use the git status command. Changes highlighted in green are ready to commit, while those highlighted in red must still be added to staging.

Stash

Git stash removes changes from your index and "stashes" them for later use. It's useful if you want to put something on hold and work on something else for a while. You can only stash one set of changes at a time.

Upstream

In the context of Git, upstream refers to where you push your changes, which is typically the master branch.

Merge

To add changes from one branch to another, use the git merge command in conjunction with pull requests.

Origin

The default version of a repository is referred to as the origin. Origin can also be used as a system alias to communicate with the master branch. To push local changes to the master branch, use the command git push origin master.

Pull

Pull requests represent suggestions for changes to the master branch. If you're working with a team, you can create pull requests to tell the repository maintainer to review the changes and merge them upstream. The git pull command is used to add changes to the master branch.

Push

Pushing refers to sending your committed changes to a remote repository such as GitHub.com. For instance, if you change something locally, you'd want to then push those changes so that others may access them

GIT Commands

Here are some basic GIT commands you need to know

How to setup your Git username:

With the command below you can configure your user name:

How to setup your Git user email:

This command lets you setup the user email address you'll use in your commits.

How to Initialize a Git repo:

Everything begins here. The first step is to create a new Git repo in your project's root directory. You can do so with the command below:

How to clone a Repository:

Git clone is a Git command line utility which is used to target an existing repository and create a clone, or copy of the target repository

Cloning to a specific folder

Clone the repository located at ＜repo＞ into the folder called ~＜directory＞! on the local machine.

How to Create a New Branch in Git:

By default, there is only one branch, the main branch. You can use this command to create a new branch. Git will not switch to it automatically; you must do so manually with the following command.

To create a new branch use:

How to List Branches in Git:

Using the git branch command, you can see all of the branches that have been created. It will display a list of all branches, with the current branch marked with an asterisk and highlighted in green.

How to Switch Branches in Git:

When you create a new branch, Git will automatically switch to it.
If you have multiple branches, you can easily switch between them by running git checkout:

How to delete a branch in Git:

You can delete the branch using below command

How to add a file to the staging area in Git:

The command below will add a file to the staging area. Simply replace filename here with the name of the file you want to include in the staging area.

How to add all files in the staging area in Git:

You can use a wildcard to add all files in your project to the staging area.

How to add only certain files to the staging area in Git:

You can add all files beginning with 'str' to the staging area by using the command below.

How to Check repository's status in Git:

This command displays the current repository's status, including staged, unstaged, and untracked files.

How to Commit changes with a message:

This command allows you to specify a brief summary of your commit message.

How to Commit changes (and skip the staging area) in Git:

Using the -a and -m options, you can add and commit tracked files with a single command.

How to View your commit history in Git:

This command displays the commit history for the current repository:

How to view commit history including changes in Git:

This command displays the current repository's commit history:

How to view log stats in Git:

This command causes the Git log to display some statistics about the changes in each commit, such as the number of lines changed and file names.

How to Amend the most recent commit in Git:

You can use git commit —amend to modify and add changes to the most recent commit.

How to view a specific commit in Git

Replace commit-id with the id of the commit found in the commit log.

How to view changes made before committing them using "diff" in Git:

You can specify a file as a parameter to only see changes to that file. By default, git diff displays only unstaged changes.

To see any staged changes, we can use diff with the —staged flag.

How to revert staged changes in Git:

If you want to remove a certain file from the stage:

Remove all staged files:

How to Rename files in Git:

This command stages the changes, then it expects a commit message.

How to push changes to a remote repo in Git:

When all of your work is complete and ready to be saved on a remote repository, use the commands below to push all changes:

First Push

Push a local branch for the first time:

After that, then you can just use:

Push local branch to different remote branch

To push a local branch to a different remote branch, you can use:

How to Undo Last Push

If you have to undo your last push, you can use below command.

How to fetch remote repo changes in Git:

This command will download changes from a remote repository but will not merge them into your local branch (use git pull to do that).

How to pull changes from a remote repo in Git:

If other team members are working on your repository, you can use the command below to retrieve the most recent changes made to the remote repository:

If you have a branch called my_feature and you want to pull that branch, you can use:

How to merge two branches in Git or Rebase:

When you run git merge, your HEAD branch will generate a new commit, preserving the ancestry of each commit history.
The rebase re-writes the changes of one branch onto another without creating a new commit.

Merge Master Branch to Feature Branch:

Or with rebase option, use below command:

Merge Feature Branch to Master Branch:

How to use GIT STASH:

Git stash temporarily shelves (or stashes) changes you've made to your working copy so you can work on something else, and then come back and re-apply them later on.

To stash changes use below command

If you want to unstash those changes and bring them back into your working directory use:

API Response Validation using Postman

TaheraFirdose — Sun, 20 Jun 2021 18:15:08 +0000

In this article, we will learn how to validate the response by writing test scripts and assertions for testing API using postman.

Postman is an excellent utility tool for creating integration tests for rest API endpoints because it allows you to write test scripts and add assertions. We can determine if a test passes or fails based on the output of these assertions.

Writing tests

In your requests and collections, you can use the Tests tab to write tests that will run when Postman receives a response from the API you requested. For each request, you can add as many tests as you need. When you add tests to a Collection, they will execute after each request inside it.
We can enter the script manually or use the Snippets, which is available on the right side of the code editor

Basic test syntax

The pm.* API is used to write your test under the Tests tab in Postman. The pm.test() method accepts 2 parameters.

The first parameter is the name of the test(as a string), it's important to give your test a descriptive name so that you can provide more information if it fails.
The second parameter is a function that will pass or fail the test if any assertions within your function pass/fail. The function returns a boolean (true or false)

Postman uses the Chai assertion library for creating assertions. It’s based on the BDD style of assertions which make it highly readable and understandable

Test results

After you execute the request with the test scripts, go to the Tests tab in the response viewer. It will display a list of tests with the results passed or failed. A boolean which returns true is marked as passed while a boolean which returns false is marked as failed.

Writing test scripts

Scenario 01: Verify the status code is 200

Scenario 02: Verify status code contains a string. Example: 201 (created), 200(OK)

Scenario 03: Verify the status code from a list of expected status code (include them all in an array and use one of)

Scenario 04: Verify the response time is below 1000ms and above 200ms

Scenario 05: Verify the presence of header and the value.

Scenario 06: Verify the properties of the objects in response body

The below test include multiple assertions as part of a single test, Even if one assertions fails, the test as a whole will fail. All assertions must be successful for the test to pass

Scenario 07: Verify the values in the response body

Response Body

Scenario 08: Verify the response value against a variable

Setup variable in Pre-request Script

ResponseBody

Scenario 09 : Verify the current Environment

Scenario 10 : Verify the response is valid and has a body and the bodytype is JSON

Scenario 11 : Verify the data type of the response

Conclusion

This article aims at showing you how to utilize Postman to write automated tests for your APIs which will allow you to bridge the gap between development and quality assurance, and also minimize the surface area of bugs in your API.

How To Automate API Testing With Postman

TaheraFirdose — Sun, 20 Jun 2021 17:02:34 +0000

In this article, we will learn how to validate the response by writing test scripts and assertions for testing API using postman.

Writing tests

We can enter the script manually or use the Snippets, which is available on the right side of the code editor

Basic test syntax

The pm.* API is used to write your test under the Tests tab in Postman. The pm.test() method accepts 2 parameters.

The first parameter is the name of the test(as a string), it's important to give your test a descriptive name so that you can provide more information if it fails.
The second parameter is a function that will pass or fail the test if any assertions within your function pass/fail. The function returns a boolean (true or false)

Postman uses the Chai assertion library for creating assertions. It’s based on the BDD style of assertions which make it highly readable and understandable.

Test results

Writing test scripts

Scenario01: Verify the status code is 200

Scenario02: Verify status code contains a string. Example: 201 (created), 200(OK)

Scenario03: Verify the status code from a list of expected status code (include them all in an array and use one of)

Scenario04: Verify the response time is below 1000ms and above 100ms

Scenario05: Verify the presence of header and the value.

Scenario06: Verify the properties of the objects in response body

The below test include multiple assertions as part of a single test, Even if one assertions fails, the test as a whole will fail. All assertions must be successful for the test to pass

Scenario07: Verify the values in the response body

Response Body

Best Practices for REST API Testing

TaheraFirdose — Fri, 11 Jun 2021 15:26:09 +0000

What is REST, and what are REST APIs?

REST stands for Representational State Transfer and API stands for Application Program Interface. It is a type of architectural design pattern for APIs. It is a predominant development style for web applications and services. APIs that are designed using REST are called REST APIs, and they allow web applications and services to interact with resources stored in a web server. These interactions typically take place over HTTP and usually consist of the following:

GET (retrieval of the resource)
POST (creation of the resource)
PUT (updating the resource)
DELETE (deletion of the resource)

1. Make an API testing strategy checklist

The test strategy is the high-level description of the test requirements from which a detailed test plan can later be derived, specifying individual test scenarios and test cases. An API test strategy lays out your goals and the steps to get there. This can be a detailed formal document or a checklist such as below.

• Define the testing process, level of testing, roles, and responsibilities of every team member.
• Discuss with the Product owner and development team about the list of API’s the organization is going to use and prioritize them in order of their importance to applications and customers.
• Determine how often the tests should be run, and how are they deployed with a commercial testing tool or an internally developed tool.
• Define the types of tests to run. For example access security, endpoint security, data security, data validation and file validation.
• Develop a plan that ensures test data won't harm production data that's required for business analytics and reporting.
• Evaluate and select an API testing tool.
• Schedule and regularly conduct functional and security tests.
• Plan for resources to maintain and update API tests.

2. Pick the right API tool

API testing isn’t very different from any other testing. But, it requires specific tools to test it. All API testing tools let testers submit requests manually — in other words, you write out the request, send it, and see how the API reacts. However, it would take a while to test any API this way, which is why many testing tools also support automated tests. Automated testing systems run many scenarios quickly with minimal human input. A good API testing tool, especially one with automated testing, saves time and helps testers shift left to catch bugs earlier. Many of these tools are available for download completely free of charge, while others require a purchase.

3. Perform API smoke testing.

When a new API is ready for testing, the very first test that needs to be performed is smoke testing. Smoke test is a mini and rapid regression test to ensure that the basic and critical functionality is working. This helps determine if the API code is flawed and avoids any further testing which will be a waste of time and resources. As such, a typical API smoke test could be the following:

• Ensure API responds to correct authorization via all agreed auth methods – Bearer token, cookies, OAuth, etc. – as defined in the spec
• Test the basic API’s to check if it responds
• Test the API’s with only positive test data to see if it responds with a payload in the correct format.
• Test the API and how it interacts with the other APIs and components it’s supposed to interact with.

4. Mirroring API Testing and Production Phase

During the API testing phase, the development teams need to create identical conditions like the one in the production. This will ensure that the APIs function accurately and will allow testing bug fixes, performance bottlenecks and important security bugs in an environment similar to the one the customers are facing.

5. Keep track of API Responses and save them for future use.

Many testers on the success or failure of each API, discard the set of responses after they’ve finished running their functional tests. This is wrong, as responses from an API are very useful data that can be used for comparing the inconsistency or error caused in future builds. This can help testers to figure out exactly which modification is causing the error. Without recording these test results, important history is lost.

6. Test Positive and Negative Scenarios

As a tester, we often think about the “Happy Path”- the path that the user will most likely take when they are using our application. We often perform API testing to verify that every endpoint returns a “200 OK” or similar successful response.
It’s equally important to think about negative testing as it can expose improperly handled errors that could impact a user. By performing negative testing, a tester can see whether or not their API can deal with receiving incorrect or invalid data with an error message instead of a hard crash. This will improve the efficiency of the application and help the app to respond in scenarios where invalid data is provided.

7. Never Ignore Security Tests

API allows data exchange between applications. If a hacker breaches API security, he/she can access sensitive data stored on the website. In order to protect applications from exploitation and security breaches, all APIs must be tested for security flaws and exploits. This can be performed using various testing tools that help to run and scan security tests with some extra features.

DEV Community: TaheraFirdose

Payload Creation using Org.Json Library - Part 7

Steps:

Important Note:

Sending Complex Json using Org.json:

Steps:

Sending Json in Array form using Org.json:

Multiple ways to send Payload - Part 6

Pass JSON file as payload

File jsonData = new File(“src\test\resources\jsondemo.json”)

Below is the post request:

Below is the output after code execution:

Creating Payload as JSON Object:

How to send POST Request in Rest Assured - Part 5

Once you have the import of REST Assured set up, add the following static imports to your test class:

Now let's look at an example of POST Request using Rest Assured

1.Set URI:

2. Call post method

3.Validate Response Code

4.Rest Assured – Validate Response Content

5. Number Validation Using Rest Assured

Below is the output after code execution

Rest Assured E2E Testing - Part 4

Understanding HTTPS methods, status codes and syntax

What is HTTP?

Different Types of HTTP Methods:

GET:

POST:

PUT:

DELETE

PATCH

HTTP Response codes

Some of the most common HTTP response codes used with REST are as follows :

What is Payload?

JSON Syntax Rules

WHAT is JSON?

What Is XML?

Let’s have a look at REST-Assured Syntax:

Let's try to understand the above code:

Rest Assured E2E Testing - Part 3

Setup A Basic REST Assured Maven Project In Eclipse IDE

Pre-requisites

Creating Maven Project in Eclipse

Rest Assured E2E Testing - Part 2

How to create a Fake REST API with JSON-Server

Installation and Configuration of NodeJS:

Installing Json Server

$ npm install -g json-server

JSON File

Running The Server

$ json-server --watch db.json

Rest Assured E2E Testing - Part 1

API Testing Process Using REST Assured

What is REST Assured?

Advantages of Rest Assured

Disadvantages of Rest assured

Git CheatSheet

What is GIT

Git Terminologies:

Repositories

Branch:

Remote:

Master

Checkout

Commit

Fetch

Fork

Head

Index

Stash

Tags

Upstream

Merge

Origin

Pull

Push

GIT Commands

How to setup your Git username:

How to setup your Git user email:

How to Initialize a Git repo: