Qyrus User Documentaion
  • 👨‍💻API Testing
    • What is API?
    • Getting Started
    • Functional testing
    • Functional Assertions
    • Functional Reports
    • API to DB Assertion
    • API Process
    • Advanced Features
    • Emailing & Downloading Report
    • Execute JavaScript
    • Advanced Reports
    • Advanced Features
    • Build Test script
    • Parameterization
    • GraphQL
    • REST vs SOAP vs GraphQL
    • FAQs
    • Representational State Transfer API( REST API)
  • 📱Device Farm
    • Introduction
    • Getting Started
    • Project Creation & Setup
    • Manual Testing
    • Automation
    • Test Reports and Analysis
    • Element Explorer Feature for Appium Automation Testing
    • Integrations with Collaboration Tools
    • Interrupts
    • Supported Devices and Browsers List
    • Biometric Bypass Feature for Real Devices
    • File Upload Feature for Remote Real Devices
    • Frequently Asked Questions (FAQ)
Powered by GitBook
On this page
  • Functional Testing
  • Project Creation
  1. API Testing

Functional testing

Functional Testing

  • Functional testing refers to the process of testing the individual functions, interactions, and behavior of an API to ensure that it meets the specified requirements and functions correctly.

Table of Contents

  • Introduction To Functional Testing

  • Project Creation

    • Creating a new Test Suite

      • Create Test Suite

      • Edit Test Suite

      • Delete Test Suite

  • Test Script Creation

    • Import Swagger JSON or WSDL URL

    • Upload Swagger JSON or WSDL File

    • Import from Postman Collection URL

    • Upload from Postman Collection File

    • Create Manual API

  • Build Test Script

    • Info

    • Authorization

    • Headers and Params

    • Body

  • Execute Test Script

  • Assertions

  • Functional Reports

  • Advanced Features


Introduction To Functional Testing

  • Let's pause for a moment to comprehend the benefits that Functional Testing provides in the realm of API Testing Services. Functional Testing serves the purpose of testing REST, SOAP, and GraphQL APIs. To accomplish this, the user is required to furnish API details, authorization, headers, path parameters, query parameters, functional assertions, and API-to-DB assertions.

  • To enhance the user experience, we offer tools such as JSON path extractors, XPATH extractors, JSON and XML schema generators. Upon executing the test script, users can view the generated report, which allows them to verify the results effectively.


Project Creation

Click here for instructions on how to Create Project


Creating a new Test Suite

Once the project is created, you'll be redirected to the dashboard.

Create Test Suite

Step 1: Click on "Create Test Suite"

Step 2: Enter Test Suite Name, Module name, and click on Create Test Suite button.


Edit Test Suite

Step 1: Go to the desired Test Suite.

Step 2: Click on Edit Suite icon.

  • Enter necessary Test Suite Name or Module Name, then clicks on Update.


Delete Test Suite

Step-1: Go to the desired Test Suite.

Step-2: Click on the Delete icon.

  • Confirm the deletion.


Summary of Test Suite


Test Script Creation

The options available for API creation in Functional Testing that we offer:

  • Import Swagger JSON or WSDL URL

  • Upload Swagger JSON or WSDL File

  • Import from Postman Collection URL

  • Upload from Postman Collection File

  • Create Manual API

Import Swagger JSON or WSDL URL

Generate a test script by Importing Swagger JSON or WSDL URL

  • Looking for an URL to delve into this option? You can utilize this open API:

       https://petstore.swagger.io/v2/swagger.json
       

Step-1: Provide valid Swagger JSON or WSDL URL in the field.

Step-2: Then, click on Get API's to get APIs from provided URL.

Step-3: Select required API's to be generated as Test Script. And click on Generate Test Script.

Step-4: If all processes occur as intended, the resulting list will display the generated Test Scripts as shown below.


Upload Swagger JSON or WSDL File

Step-1: In the Upload Swagger JSON or WSDL File section click on Browse button and select the desired Swagger JSON or WSDL file.

Step-2: Then Select API's to generate test script.


Import from Postman Collection URL

Looking for an URL to delve into this option? You can utilize this open API:

https://www.postman.com/collections/aa23bc182d99b5f6f93c

Step-1: Please input the provided URL into the designated field labeled Import From Postman Collection:

Step-2: Click on Get API's to retrieve the relevant APIs

Step-3: Select the API's and Generate Test Script.

Upload from Postman Collection File

Step-1: In the same section click on Upload JSON File and select Postman Collection json file.

Step-2: click on "Get API's" to retrieve the relevant APIs

Step-3: Select the API's and Generate Test Script.


Create Manual API

  • To create a manual API Test, click on Add button in the Create Manual API Test section.

  • 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.

  • Once required API details are provided, click on Save to save the Test Script.


Summary of Test Script Creation


Now, let's comprehensively grasp the process of building and executing test scripts, including a thorough explanation of all the supported options.

Build Test Script

To Build and Execute Test Script Click here!

Interested in gaining a more detailed understanding of Test Script? Below is a comprehensive list of Test Script's details.

Info

  • Additional insight regarding the Info aspect of Test Scripts

Authorization

  • Additional insight regarding the Authorization aspect of Test Scripts

Headers and Params

  • Additional insight regarding the Headers and Params aspect of Test Scripts

Body

  • Additional insight regarding the Body aspect of Test Scripts


Execute Test Script

  • Additional insight regarding the Execution aspect of Test Scripts


Assertions

  • Within the realm of API testing, assertions encompass statements or conditions that verify if the real results of API requests and responses align with the anticipated outcomes.

  • Various categories of assertions supported within Functional Testing:

    • Functional Assertions: Within API testing, Functional Assertions encompass a diverse range of validation techniques. These assertions serve the purpose of confirming the alignment between the anticipated and actual API responses. The supported assertions encompass aspects like Headers, JSON Path, XPATH, body content, and schema validation. For more comprehensive understanding Click Here

    • API to DB assertion: Within API testing, Functional Testing provides an array of assertions for API-to-DB validation, ensuring that API responses align as expected with corresponding database resources. For more comprehensive understanding Click Here


Functional Reports

  • API testing reports provide insights into functional behavior of your APIs during testing.

  • To gain insights of the reports, please navigate to the Functional Reports page.


Advanced Features

  1. Parametrization:

    • Explore Parametrization to gain a deeper understanding of its functionality.

  2. Compare and download functional reports

    • To observe the reports comparison between two API's kindly go through Compare and Download Functional Reports.

  3. Execute Multiple Test Scripts

    • This feature allows you to Execute Multiple Test Scripts.

  4. Execute Multiple Test Suites

    • Functional Testing provides an advanced capability that enables the simultaneous Execution of Multiple Test Suites.

PreviousGetting StartedNextFunctional Assertions
👨‍💻
Page cover image