API Testing
Documentation Home
  • Overview
  • Getting-Started
    • Intro-to-API
    • Table of Contents
  • Project-Setup
    • Certificates
    • Database Configuration
    • Global-&-Environment
    • Integration
    • Pre-requisite-API
    • Project Set Up
  • Functional-Testing
    • API to DB Assertion
    • Advanced Features
    • Build-Test-Script
    • Functional Assertions
    • Functional-Testing
    • 🎀Parameterization
    • Functional Reports
  • API-Process-Testing
    • Advanced Features
    • API Process
    • Getting Started
    • Performance-Testing
      • Performance Testing
  • Advanced-Features
    • Emailing & Downloading Report
    • Execute JavaScript
    • Nova AI Assertions
    • Advanced Reports
    • Xray Integration
  • FAQ
    • FAQs
Powered by GitBook
On this page
  • Contents
  • Introduction to Performance Testing
  • Project Creation
  • Creating a new Test Suite
  • Test Script Creation
  • Create Manual API Test
  • Import from Functional Testing
  • Import Swagger JSON or WSDL URL
  • Upload Swagger JSON or WSDL File
  • Import from Postman Collection URL
  • Upload from Postman Collection File
  • Build Test Script
  • Info
  • Authorization
  • Headers and Params
  • Body
  • Execute Test Script
  • Reports
  • Performance Execution Summary Reports
  • Advanced Reports
  • Advanced Features
  • Report Actions
  1. API-Process-Testing
  2. Performance-Testing

Performance Testing

PreviousPerformance-TestingNextAdvanced-Features

Last updated 1 year ago

Testing involves gradually intensifying the workload to observe the API's performance under heavier demand. Within this process, you can track response durations, review the status codes and advanced results associated with each request.

Contents


Introduction to Performance Testing

Project Creation

Creating a new Test Suite

Test Script Creation

Create Manual API Test

  • We can manually create a script by providing the valid Test Script details.


Import from Functional Testing

Step-1 : Select the Import from Functional Testing option.

Step-2 : Select the necessary scripts to be imported.


Import Swagger JSON or WSDL URL


Upload Swagger JSON or WSDL File


Import from Postman Collection URL


Upload from Postman Collection File

Build Test Script

Info

Step-1 : Select the type of API you'll be testing (REST, SOAP, GraphQL).

Step-2 : To create an API manually, it's essential to provide the required information outlined below.

Field
Description

API type

Select REST, SOAP or GraphQL.

Name

The name of your API script.

Description

A description of your script.

Context Path

The path to your specific API.

Protocol

Defines a set of rules for communication( http/https).

Endpoint

URL where a service or resource can be accessed.

Port Number

It is network address. For example: 8080.

Verbs

The type of API call. GET, POST, PUT, DELETE or PATCH.

Timeout

Timeouts are used to avoid waiting APIs response.

URL in code Enabled

Encoding special characters within the URL.


Authorization


Headers and Params


Body

Execute Test Script

Step-1 : Click on Run Button.

Step-2 : Select number of threads where it is for mimicking concurrent users or processes to evaluate system behavior under varying levels of load.

Step-3 : Select Thresold response time,where it is maximum acceptable time for a system to respond

Step-4 : Select the Environment name.

Step-5 : Then again Click on the Run button.

Step-6 : It will be navigated to reports page.


Reports

The Performance Report presents a comprehensive overview, featuring graphs depicting response time outcomes and status code results

Performance Execution Summary Reports

Test Results

Response Time Results

The Response Time Results graph showcases the relationship between the number of threads (simulated users) and the corresponding response times of the API requests. This graph helps in understanding how the system's performance behaves as the load increases.

Status Code Results

The Status Code Results graph illustrates the distribution of HTTP status codes returned by the API requests at different levels of thread concurrency. This graph provides insights into how the system handles requests under various loads.


Advanced Reports

Advanced Reports in Performance testing offer additional insights into the API executions conducted under stress, including summary reports, response latencies over time, active threads over time, hits per second graph and transactions per second.

Advanced Features

Report Actions

The Report Actions encompass user-specific functionalities including sending emails, downloading reports, test retries, ticket management, and user profile interactions.

Performance testing in API testing refers to the process of evaluating the speed, responsiveness, stability, and overall scalability of an under different load conditions. It uses parameters like thread count and analyzes responses, providing insights into response times and status codes. Advanced reports go beyond metrics, offering a deeper understanding of performance over time. They include summary reports, response latency trends, active threads data, and graphical representations of hits and transactions per second. These reports provide a holistic perspective, enabling informed decisions on optimization and scalability. Performance testing is crucial for delivering dependable APIs that meet real-world demands for speed and responsiveness

Application Programming Interface( API)
Click here for instructions on how to Create Project
Click Here to know more about Advanced Reports
Performance Testing
Introduction to Performance Testing
Project Creation
Creating a new Test Suite
Test Script Creation
Create Manual API Test
Import from Functional Testing
Import Swagger JSON or WSDL URL
Upload Swagger JSON or WSDL File
Import from Postman Collection URL
Upload from Postman Collection File
Build Test Script
Info
Authorization
Headers and Params
Body
Execute Test Script
Reports
Performance Execution Summary Reports
Test Results
Response Time Results
Status Code Results
Advanced Reports
Advanced Features
Report Actions
Click here for instructions on how to Create a Test Suite
Click here for instructions on how to Import from Swagger or WSDL URL
Click here for instructions on how to Import from Swagger or WSDL File
Click here for instructions on how to Import from Postman Collections
Click here for instructions on how to Import from Postman Collections
Additional insight regarding the Info ascept of Test Scripts
Additional insight regarding the Headers and Params ascept of Test Scripts
Additional insight regarding the Body ascept of Test Scripts
Click Here to know about Report Actions
image
gif
image
image
gif
image
image
image
gif
image
gif