Conektto
Search
⌃K
🍾

Execute API Test

Conektto's Autonomous API Test Studio uses NLP technology to analyze and create test harness for executing all your tests. Before you continue on this section, make sure you read the previous section.

Setting up Conektto API Test Workspace

After successfully publishing your API test project, you can download the API workspace from Conektto's Dashboard as illustrated below.
Click "API Workspace" to Download from the Conektto Dashboard

API Test workspace

Conektto's API Test Workspace works locally on your desktop or on a VM or cloud instance. The test workspace is composed of set of docker containers
ReactUI - To interact and perform test execution
NodeJS - API backend to interact with ReactUI and backedn MongoDB
MongoDB - Backend database to store test workspace data
FlaskAPI - For data retrieval from MongoDB to enable test data insertion and to persist test results
Mock services - To run mock runners for the API under test
Test Runner engine - To run functional API tests and analyze results
Grafana UI - Pre-built Grafana Dashboard to visualize performance test results
InfluxDB - Time series database for persisting performance test data

Download and Install API Test Workspace

​
✅
Unzip the downloaded contents and run docker setup scripts

Downloadable API Workspace is named with "Proj" prefix followed by name of your API project: as in "Proj_Demo_DocAPItest.zip"
Unzip the contents and open the contained folder in Terminal or Command line
​
​
MacOS users // sh offlinedeploym.sh
Linux users // sh offlinedeploy.sh
Windows users // run offlinedeploy.ps1
​
⚠️
Check the system requirements section for Docker Desktop requirements
​
​
​
​
​
🛑
When you are setting up the API workspace first time, it could take several minutes. After successful install, the future setup takes only few minutes.
​
✅
Watch for Terminal or Powershell CMD prompt messages confirming successful completion of the setup process.
​
​
​
✅
Confirm the installation by manually inspecting your Docker Desktop
​
​
​
🎆
Congratulations on successful setup. Examine if your API workspace setup is correct by launching API workspace on your browser http://localhost:3002/​
​
​
​
​

Working with your API Test projects on http://localhost:3002/​

​
✅
Select the API test projects that is now setup locally as test workspace.
Step 3 screenshot

Understanding API Test workspace

For each API test project designed and published in Conektto, you can see following features:
​
✔️
Visualize - Conektto's 0.1 version of API visualization from a schema perspective
​
✔️
Virtualize / mock - Mock endpoints consumable locally or VM or cloud
​
✔️
Test Data - Test data generated for functional and performance tests that are automatically associated with tests once completed insertion back to your database. You can generate more data as needed
​
✔️
Tests - Functional and Performance test case and execution platform auto generated by Conektto
​
✔️
Test Results - Test results viewer to analyze test execution results
​
​

Visualize API

​
Visualize your API Schema

​

Virtualize / Mock API endpoints

The mock endpoints for the API under test is deployed locally in port 8008. The mock can be hosted on VM or cloud as well.
Step 8 screenshot
​
ℹ️
Click on Virtual Endpoint Host : http://localhost:8008/vs/proj_db_50-8b11-4f70-8f3e-3d4c127542d1
​
​
Step 10 screenshot
​
​
​
​
Step 11 screenshot
​
​
​
​
Step 12 screenshot
​
​
​
​
Step 14 screenshot
​
​
​
​
Step 15 screenshot
​
​
​
​
Step 16 screenshot
​
​

Test Data

Conektto generates all Test Data for your entire database despite your API under test is only related to few entities. The test data is generated with unique patent pending algorithm that ensure entity relationship, order, sequence and overall integrity of the database and ready to be inserted into your database.
​
ℹ️
The test data is generated for Functional and Performance tests. Once data is inserted, the data is automatically associated with auto generated tests for Test Execution.
Test Data generator for API
​
​
✅
Click on INSERT to insert test data into your database and provide host credentials.
​
🛑
Conektto recommends you do not use your production database for insertion as this could impact on your existing live customer data sets.
Step 29 screenshot
​
​
✅
Click on GENERATE MORE DATA if your existing test data is exhausted after insertion and test execution.
​
ℹ️
Generate request has limitations with your subscriptions. Check Conektto License Model for additional details.
​
⚠️
Generate button will be disabled until successful execution of tests for previosuly inserted test data.
Step 39 screenshot
​
✅
Click on Performance link to view the test data generated for Performance Tests.
Step 45 screenshot
Step 48 screenshot
​
ℹ️
Below is the illustration of test data generation feature. This will be enabled only when all test data are exhausted. For download and setup instructions of generated test data, refer Download and Install API Test Workspace.
Step 50 screenshot

Tests (API Test Cases and Test Execution)

Conektto auto generates all API test cases and test execution engine for functional and performance. The functional tests can be executed against mock or real endpoint.
​

Functional API Tests

Step 53 screenshot
​
ℹ️
Test cases generated by Conektto covers: all status codes in the API contract, mandatory and optional parameters, schema validation and data validation. Click on the Test Case Name to review the full payload including assertion details.
Step 54 screenshot
​
✅
Click "Full Payload" to see the assertion details for each of the tests.
Step 56 screenshot
Step 57 screenshot

Run API Tests

​
✅
Click "Run Tests" to execute all the tests for the respective API test project.
Step 74 screenshot

Tests Executing

​
✅
You can see the progress of the tests as they execute.
Step 75 screenshot

Test Execution Results

​
✅
View test execution results in the "Test Results" tab
Step 76 screenshot

Test Result History

​
✅
Test execution resutls displayed as summary, detailed as well as visual representation of your API endpoints.
Step 77 screenshot
​
Step 78 screenshot
​

Performance Tests

​
ℹ️
Conektto auto generates performance tests along with the test data for respective volume that are executed locally on the docker containers. Select the type of the performance tests from the drop down:
​
✔️
Baseline: Basic benchmark tests with low volume, shorter duration and slower ramp-up
​
✔️
Load - Lower volume, shorter duration but faster ramp-up threads
​
✔️
Stress - Higher volume and longer duration of threads
​
✔️
Endurance - Lower volume and longer duration of threads
​
​

Grafana visualization

Conektto's performance test executions are persisted in InfluxDB container and can be visualized for relevant performance metrics in the Grafana plug-in.
​
✅
Launch Grafana container from https://localhost:3004 with default Grafana user name as admin and password as admin@123
​
​
Contact Conektto for testing high volume performance scenarios on Kubernetes Cluster which is currently only for a Enterprise users.