ContextQA
  • What is ContextQA?
  • Getting Started with ContextQA
    • Setup
      • Sign-Up / Login
      • Installing ContextQA Extension
    • Test Automation
      • Automation with Recorder
      • Automation with AI Agent
    • Advance Testing
      • Cross Browser Testing
      • API Testing
      • Visual Testing
      • Performance Testing
      • Accessibility Testing
      • Mobile Testing
        • Automate Test
          • Integrating VCS
          • Integrating Device Farm
          • Linking A Repository
          • Scanning Repositories
          • Test Execution Process
          • Configuring Tests
        • Mobile Testing Report
    • Manage Test Cases
      • Test Suite
      • Test Plan
    • Quality Insights
    • Integration
      • Slack Integration
      • Jira Integration
  • Advance Features
    • Self-Healing Test Cases
    • Parallel Test Execution
    • Parameterization
    • Environment Management
    • Visual Regression Testing
    • Performance Testing
    • Accessibility Testing
    • Generate Code
    • Root Cause Analysis
  • ContextQA Extension
    • Installing ContextQA Extension
    • Logging in to ContextQA from the Extension
    • Creating a Test Case in the ContextQA Extension
    • Edit Test case in Extension
    • Editing Test Steps in the ContextQA Extension
    • Deleting a Test Case from the ContextQA Extension
    • How to Re-record Test Steps in ContextQA
  • ContextQA Portal
    • Sign-Up / Login
    • ContextQA Dashboard
    • Test Development Section
      • Create
        • Create Test Case
        • Create Manual Testcase
        • Create Test Case with the help of AI
        • Create Test Suite
        • Create Cross-Browser Test Plan
        • Creating an Element Manually
        • Creating a Step Group
        • Creating Test Data Profiles
        • Create Cross-Device Test Plan
        • Creating an Environment
      • Edit
        • Edit Test Case
        • Editing Test Steps
        • Edit Test Suite
        • Editing Test Data Profile
        • Editing Test Plan
        • Edit Step Group
        • Edit Element
        • Edit Environment
      • Delete
        • Deleting a Testcase
        • Delete Test Step
        • Delete Test Suite
        • Delete Step Group
        • Delete Elements
        • Delete Test Data Profile
        • Delete Test Plan
        • Delete Machine/Device within Test Plan
      • Call Function
        • Call/Use Step Group in Testcase
        • Call Test Data Profile in Testcase
        • Call Environment
      • Run
        • Run Testcase
        • Run Details section
        • Run History
        • Executed Test Steps with visual regression
      • Elements/Conditions/Parameters
        • Add If Condition
        • Add While Condition
        • Add Element in Test Steps
        • Add Parameter in Test Case
    • API Testing
    • Creating Workspace
    • Enable Jira & Link issues
    • Bug report
  • ContextQA Insights
  • FAQ/Others
    • Assertion
    • AI Result/ Quick Fix
    • How to add Network idle Template
    • How to upload file and how to use File upload Template
    • How to add Page Display Templates
    • How to add Test Step to Visit a Page
    • How to Switch Tabs using Template
    • How to add Wait Template
    • Test Case Screenshot
    • Timeout Template
    • Element Directory in Extension
    • Find Locater of an Element
    • TestSteps Reorder
    • Test Plan Scheduler
    • Restore Deleted Test Case
    • Search Test case
    • Clone Test Step
  • Integration
    • Slack Integration
    • Jira Integration
Powered by GitBook
On this page
  • Interactive Demo
  • Step-by-Step Guide
  • Need Help?
  1. Getting Started with ContextQA
  2. Advance Testing

API Testing

PreviousCross Browser TestingNextVisual Testing

Last updated 3 months ago

This guide outlines step-by-step instructions for performing API testing using ContextQA. You'll learn how to:

  • Create an API test step

  • Send API requests and preview the response

  • Store the API response in a variable

  • Verify response

    • Verify by response value

    • Verify by status code

By following this guide, you can effectively validate the functionality and reliability of your APIs

Interactive Demo

Here’s an interactive demo to quickly guide you through the process. Use it to explore the steps in an engaging, hands-on way.

Step-by-Step Guide

Prefer detailed instructions? Here’s a comprehensive step-by-step guide to walk you through the process at your own pace.

  1. Navigate to Test Development Section

  1. Select and Click on a Test Case

  1. Click on a Test Step, enter 'API' and choose the 'REST_API' template

  1. Click on the Three-Dot Button of the Test Step to View More Details

  1. Click on the Title Field and Enter a suitable Title for the API

  1. Select the required API Method

  1. Enter the API URL Path

  1. Click on Send Button to view the Response Preview below

  1. Enter Header Name and Header Value in the respective fields if required

  1. Click on Next Button to proceed with Storing Response

11. Enter a Variable Name to store the API's Response

  1. lick on Next Button to proceed with Validation of Response

  1. Enter the variable name, followed by a '.' and the JSON path of the response you want to validate

  1. Select the suitable Verification Method for validation of the Response

  1. Select the expected Data Type of the response

  1. Enter the Expected Value to compare with the Response Value

  1. Click on Status tab

  1. Enter the Expected Response 'Status Code' and Click on Create

  1. Click on Create Button to create the API Test Step

  1. Click on Run to execute the Test Case

  1. Click on Run History

  1. The API Test Case has been executed and passed successfully

Need Help?

Check the detailed user guide or contact our support team through email or live chat if you run into any issues during setup.

Congratulations! You're now ready to start using ContextQA to streamline your testing process. Explore the platform and take advantage of our advanced testing automation features.