Do you think IIT Guwahati certified course can help you in your career?
Introduction🎯
ReadyAPI is an all-in-one automated API testing platform designed to provide smooth functioning of testing workflow. It helps manage, create and execute functional, performance, and security tests. The UI is user-friendly, and one can work on it without prior scripting knowledge.
In this article, we will discuss the ReadyAPI dashboard and its test tiles
Technological Services in ReadyAPI 🧑💻
➡️ REST Services
REST stands for REpresentational State Transfer. It is a set of architectural constraints to create web services and is one of the most common choices in terms of public APIs. REST API transfers the representation of the state of the client’s request to the receiver or endpoint via HTTP. HTTP allows several actions on data- GET, PUT, DELETE, POST. REST services usually use JSON file format for web services.
REST services in ReadyAPI use two test steps :
REST Request
It offers features like :
🔸Send requests, receive responses and view them in simpler forms in multiple editors.
🔸Provide authorization to the request.
🔸Create and view request representations.
API Connection
It is a protocol-agnostic ( manage extreme congestion in the network) test step and offers a streamlined interface.
➡️ SOAP Services
SOAP stands for Simple Object Access Protocol. It is a messaging protocol that creates web APIs with XML. Since XML can be easily understood, this markup language was used as the medium for exchanging data between applications. It works on transfer protocols like Hypertext Transfer Protocol (HTTP), SMTP(Simple Mail Transfer Protocol), and TCP(Transmission Control Protocol).
It offers features like :
🔸Send requests, receive responses and view them in simpler forms in multiple editors.
🔸Provide authorization to the request.
🔸Edit and view request headers.
With the help of ReadyAPI, the tests are performed better in ways like :
▶ Test the service using the ReadyAPI Performance module designed to handle the heavy load on web servers.
▶ Test the service using the ReadyAPI Test module to verify the service is working as expected.
▶ Test the service using the ReadyAPI Virtualization module, which creates a virtual copy of the service and writes tests for the functionality that is not yet completed.
About Ready API Dashboard 📃
ReadyAPI dashboard uses multi-functional tiles, which help to view updated information about tests to be run and create new tests and projects.
This is what a ReadyAPI dashboard looks like :
Test Tiles in ReadyAPI⭐
The dashboard contains the following ReadyAPI test tiles :
➡️New Test Tile
The New ReadyAPI Test tile is used for creating a new Functional Test, Security Test, Load Test, Virtual API, and Empty Project.
The New Test tile content depends on the ReadyAPI licenses. On having one license, matching tests can be created only. ReadyAPI Performance Pro license allows only load tests to be created using the tile. However, the ReadyAPI Test Pro license allows to create functional, security, load tests, and virtual APIs.
➡️Test Suite Status Tile and Test Case Status Tile
📌 Test Suite Status Tile
As the name suggests, the ReadyAPI Test Suite Status tile displays the status of recently run test suites of functional tests.
📌 Test Case Status Tile
Use the ReadyAPI Test Case status Tile to get information about recently run test cases. The Test Case Status is different from Test Suite Status Tile because it displays data for test cases run from test suites and test case levels.
The tile displays the sample data if there is no functional test or it is not yet run. Both tiles help in knowing the quality of the API. The result is displayed in the form of a bar graph where the horizontal axis shows the name of the test suite and the vertical axis shows the total number of test cases in the test suite.
⚠️Note -To use the tiles, the user requires a ReadyAPI Test Pro license.
Some of the actions that can be performed on the tiles are :
1️⃣Filter Test Status
The user can filter the test suites from options: Fail, Pass, or unknown.
2️⃣ Filter Projects
To view the test suite status of a particular project, the user can choose the same from the drop-down list. By default, this tile shows the status of all the recently run projects.
3️⃣Set Time Interval
The test status of a project can be viewed depending on the time. The user can select the same by clicking in the top-right corner of the tile. The options in the drop-down are Today, Yesterday, Last 7 days, Last 30 days, and Custom. The Custom option lets the user choose any arbitrary period.
4️⃣View Details
The user can view the summary of the test suite result by pointing to the desired bar in the chart.
To view the full description of a test suite, click on the bar or right-click anywhere in the region of the tile and select View Details. The window will look like this:
The window shows the bar graph of the details of the test suite and a table having the following information :
⭕ Names of Test Suite, Test Case, and Project
⭕ The status of the Test Suite, which can be - fail, pass, or unknown.
⭕ Number of steps in each test case.
⭕ Test case runtime, in milliseconds.
⭕ Date and time of the last test run.
To view details of each test suite case, click on Open.
5️⃣ Export Details
To save or print the Test Suite Status tile report, click on or right-click anywhere in the tile and select the Generate Report option.
➡️Load Test Results Tile
The Load Test Results tile displays the recent results of load test runs. The information is displayed in the form of a bar chart where the horizontal axis shows the names of load tests and the vertical axis shows the total number of errors in a test. The tile displays the sample data if there is no load test or it is not yet run.
⚠️Note To use the tile, the user requires a ReadyAPI Test Pro license.
Some of the actions that can be performed on the tile are :
1️⃣Filter Projects
To view the load test result of a particular project, the user can choose the same from the drop-down list. By default, this tile shows the load test results of all the recently run projects.
2️⃣Filter Values
The user can select the values to be displayed on the chart at the bottom of the tile. The options are :
⭕Average(Avg) Response Time - This tells the average time, in milliseconds, for a server to respond.
⭕ Duration - The duration of the test run in seconds.
⭕ Failures - The total number of errors in the test run.
3️⃣Set Time Interval
The Load Test Results of a project can be viewed depending on the time. The user can select the same by clicking in the top-right corner of the tile. The options in the drop-down are Today, Yesterday, Last 7 days, Last 30 days, and Custom. The Custom option lets the user choose any arbitrary period.
4️⃣View Details
The user can view the summary of the load test result by pointing to the desired bar in the chart.
Target executions are the number of single pieces of test scenarios executed one after another during a test run.
To view the full description of a load test result, click on the bar in the chart. The window will look like this:
The window contains the bar graph showing how test duration, response time, and the number of failures have changed during the period set by the user. The table shows the following information:
⭕ Names of Load Tests and Project
⭕ Number of VUs (virtual users)
⭕ The Median time taken, which is the time taken to execute a scenario.
⭕ Number of failures(errors) in the test run and transactions per second(TPS).
⭕ The status of the Test Run, which can be - fail or pass.
⭕ Date and time of the last test run.
To view details of each test, click on Open.
5️⃣ Export Details
To save or print the Load Test Result tile report, click on or right-click anywhere in the tile and select the Generate Report option.
➡️Security Scan Status Tile
The security scans are ReadyAPI tools that help to identify any security threat in the user’s target services. The Security Scan Status tile displays the recently run security scans. The information is displayed in the form of a bar chart where the horizontal axis shows the scan types of the ReadyAPI and the vertical axis shows the total number of scans in the project. The tile displays the sample data if there is no security test or it is not yet run.
⚠️Note- To use the tile, the user requires a ReadyAPI Test Pro license.
Some of the actions that can be performed on the tile are :
1️⃣Filter Projects
To view the security scan status of a particular project, the user can choose the same from the drop-down list. By default, this tile shows the security scan of all the recently run projects.
2️⃣Filter Scans
To view a particular security scan of the current project, the user can choose the same from the drop-down list. By default, this tile shows all the security scans of the project.
3️⃣Set Time Interval
The security scan status of a project can be viewed depending on the time. The user can select the same by clicking in the top-right corner of the tile. The options in the drop-down are Today, Yesterday, Last 7 days, Last 30 days, and Custom. The Custom option lets the user choose any arbitrary period.
4️⃣View Details -
The user can view the summary of the security scan result by pointing to the desired bar in the chart.
To view the full description of a security scan, click on the bar or right-click anywhere in the region of the tile and select View Details. The window will look like this:
The window shows the bar graph of the details of the security scan and a table having the following information :
⭕ Names of Security Scan, Request Names and Project
⭕ The status of the Test Suite, which can be - fail, pass, or unknown.
⭕ Date and time of the last test run.
To view details of each security scan, click on Open.
5️⃣ Export Details
To save or print the Security Scan Status tile report, click on or right-click anywhere in the tile and select the Generate Report option.
➡️Virtual APIs Tile
With the help of the Virtual APIs tile, the user can start virtual services that work similarly to the real APIs created. The tile displays the sample data if there is no virtual test or it is not yet connected.
⚠️Note- To use the tile, the user requires a ReadyAPI Test Pro license.
To start all the virtual services, click and to stop all the services, click .
The Virtual API tile contains a table that has -
⭕ Virtual Services that are in the projects of the current workspace.
⭕ Virtual Services that are on the servers which were added to projects of the current workspace.
⭕ Virtual Services that are on the servers which were found automatically in the user’s local network. For this, ReadyAPI finds and connects to the server.
The table above displays the following information :
🔲 Virtual Service Name.
🔲 Status which shows the runtime and whether the virtual service is running. Click to run or to stop this service.
🔲 The name of the project where virtual service belongs.
🔲 A port for virtual service.
Some of the actions that can be performed on the tile are :
1️⃣Add Virtual APIs
ReadyAPI has a feature that automatically adds a list of virtual services after it detects that a virtual service is running on the local computer. The tile displays sample data if the user has no virtual services.
To add a virtual service manually, click Create a virtual API button (this button is only visible if the tile has no available information on the virtual service) on the tile and follow the steps mentioned.
A virtual service can be created from - API definition, Recorded traffic, and REST resource.
The user must enable the virtual service discovery for ReadyAPI to find virtual services in the local computer. The user must also connect to VirtServer instances using the username and password specified in the Virtual Services of ReadyAPI Virtualization editor.
2️⃣Search for Virtual APIs
The tile searches for virtual APIs on the servers that are added to the user’s test project and in the local network. The Virtual API tile searches for VirtServer instances. The user can search for virtual service by using the Search table field, which has options in the drop-down as :
🔲 All- It searches the name, port, and location columns.
🔲 Location -It searches the location column.
🔲 Running - It shows the running virtual APIs.
🔲 Stopped- It shows the stopped virtual APIs.
3️⃣ Export Details -
To save or print the Security Scan Status tile report, click on or right-click anywhere in the tile and select the Generate Report option.
Customize ReadyAPI 📑
The topic is about customizing the ReadyAPI according to the user's needs.
1️⃣Preferences
There are multiple customization options for many features and tools in ReadyAPI Preferences. For opening the Preferences dialog :
Click Preferences button on the ReadyAPI toolbar.
OR
Select File in the main menu, then Preferences.
OR
Click Preferences in the License Manager dialog box.
2️⃣Plugin Development
The process involved in plugin development is as follows:
A Basic Project
Create a plugin project – mvn archetype:generate.
Build and package – mvn install.
Install the plugin file and add it to your ReadyAPI.
Try out the plugin and make sure it works.
Remove the plugin again and it will be replaced with a customized version.
Customize the Plugin
Open the project in the desired java development environment.
Change the PluginAction.java class.
Edit metadata to reflect changes.
Build and package – mvn install.
Install the plugin file and add it to ReadyAPI.
Try out the plugin and make sure it works.
3️⃣Java Virtual Machine (JVM) Settings 🔆
⭕JVM Parameters
It describes the parameters/variables that ReadyAPI passes to JVM to develop the environment.
⭕ Modifying JVM Settings
The user can modify the JVM parameters according to their needs.
4️⃣ Workspaces
The workspace contains all the projects made by the user.
⭕Managing Workspaces
The workspace can be created, removed, and renamed. The user can switch between the workspaces and load them from a file.
⭕Workspace Modes
ReadyAPI workspaces can be used either in Tabbed or SIngle Panel mode. This setting can be done by :
🔲 Click on the ReadyAPI toolbar.
🔲 Move to the UI tab in the ReadyAPI Preferences window.
🔲 Select the desired Workspace type option from the drop-down menu.
⭕Workspace Properties
The user can set the workspace properties in the Workspace Properties table. Select the desired workspace item in the Navigator.
5️⃣Logs in ReadyAPI
The logs provide information about the events or actions in the ReadyAPI.
6️⃣Accessibility Features
ReadyAPI is a versatile tool. It includes multiple options for user convenience in terms of screen UI and benefits those who have difficulty seeing the screen.
We hope you have understood everything about test tiles in ReadyAPI. 🙌
Frequently Asked Questions
What is an API?
API stands for Application Programming Interface. API is a set of defined rules or protocols that allow communication between two or more computer programs or applications.
Is ReadyAPI free?
The ReadyAPI Test, Performance, and Virtualization module is not free. One needs to pay to use it after a 14-day free trial.
How to update ReadyAPI?
To update, click Preferences on the ReadyAPI toolbar. In the left part of the ReadyAPI Preferences window, select the Version Update.
Is ReadyAPI and SoapUI Pro same?
SoapUI Pro is the older version. and now it has become SoapUI NG Pro and is a part of ReadyAPI Suite.
In this blog, we studied the ReadyAPI workspace, test tiles, and other concepts. We also explored technological services in ReadyAPI in detail. We further discussed how to customize the ReadyAPI. You can refer to similar articles for further information
242+ registered 
