Webtesting.io JSON Web Services Automated Testing Documentation - Version 1.4.2

Back to Documentation Home Page

Overview

We recently enhanced the Webtesting.io platform based on very insightful user feedback. The Webtesting.io JSON Web Services Automated Testing solution is to free to download, and use. Click here to download. By downloading the Webtesting.io JSON Web Services Automated Testing solution, means you have agreed to our End-User Terms and Conditions.

Webtesting.io:

Webtesting.io Excel Worksheet Overview

The Webtesting.io Excel Worksheet contains two separate worksheets: Tests and Metrics. The Tests Worksheet contains the primary information for the automated API tests, and the test results. Testers will spend the majority of their time working in the Tests worksheet to manage their automated tests.

The Tests Worksheet

Webtesting.io API Tests Worksheet

The Metrics worksheet contains the historical test metrics. These useful test metrics include Total Number of Test Scripts Passed, Total Number of Test Scripts Failed, and Percentage of Test Scripts Passed are automatically captured and documented.

The Metrics Worksheet

Webtesting.io Solution API Metrics


Webtesting.io Excel Worksheet Columns and its Definitions

The Tests Worksheet Columns

Column Column Name Column Description
A Test Name The name of the automated test case or script.
B Test Description The description of the automated test case or script.
C URL The Target API's endpoint URL.
D HTTP Verb Identify the appropriate HTTP Verb to run the test. All HTTP Verbs are supported including: POST, GET, DELETE, PATCH.
E Header Name Value Pair List May specify standard HTTP Header in a name/value pair list. Supports YAML syntax. For example: Content-Type: application/json; charset=utf-8. Different types of authentication options are also possible.
F JSON Document The JSON Request document required by the JSON Web Service. This should be specified in a normal JSON format. This is only required for JSON Web Services that require incoming JSON data via the HTTP POST VERB. Automated tests using the GET HTTP VERB do not require any data in this cell to properly run the test.
G Expected Name The JSON element name being tested. If the element is part of an array, enter the name of the array element and its ordinal position. For example, email[2] would test the second element of the array called email. Arrays are one-based; start with (1) one.
H Expected Conditional Expression The column accepts natural language, logical operators (statements) to test for Pass or Fail, which is reported in Column (K) - Pass/Fail. The following natural language statements are supported: Equals, Greater Than, Less Than, Contains, Starts With, Ends With
I Expected Value The expected value is the anticipated value based on the Expected Name element in Column (G). This column is the expected test value used in Column (K) - Pass/Fail.
J Actual Value The actual value is data returned from the JSON API response.
K Pass/Fail The comparison of the Expected Value and Actual Value columns. This column uses the logical operators defined in Column (H) - Expected Conditional Expression.
L Last Ran The date/time is automated test's date timetamp.
M Actual Response From API The actual "raw" Web Service's JSON response.
N Actual Response Time The actual API response time in seconds (broken down in milliseconds).
O Maximum Response Time This allows the tester to establish the acceptable maximum API response time in seconds (thousandths of seconds is supported). This is used for API performance testing.
P Response Time Pass/Fail Displays whether Column (N) - the Actual Response Time passed or failed the Column (O) -Maximum Response Time.
Q Expected Response Header Name The HTTP Response Header is also testable. HTTP Response Header, in general, contains a name/value based data structure. This column allows the tester to identify name of the HTTP Response Header to test.
R Expected Response Header Conditional Expression The column accepts natural language, logical operators (statements) to test for Pass or Fail, which is reported in Column (U) - Response Header Pass/Fail. The following natural language statements are supported: Equals, Greater Than, Less Than, Contains, Starts With, Ends With
S Expected Header Response Value The expected (HTTP) header response value is the anticipated value based on the Expected Response Header Name element in Column (Q). This column is the expected test value used in Column (U) - Response Header Pass/Fail.
T Actual Response Header The actual "raw" Web Service's HTTP Header response. This contains a name/value pair data structure.
U Response Header Pass/Fail The comparison of the Column (S) - Expected Header Response Value and Column (T) - Actual Response Header columns. This column uses the logical operators defined in Column (R) - Expected Response Header Conditional Expression.

The Metrics Worksheet Columns

Column Column Name Column Description
A Date The completion date and time for a round of testing, which includes all test scripts in the Tests worksheet.
B Total Number of Test Scripts The total number of test scripts in the Tests worksheet.
C Number of Test Scripts Passed The total number of test scripts that passed in the Tests worksheet.
D Number of Test Scripts Failed The total number of test scripts that failed in the Tests worksheet.
E Percentage of Test Scripts Passed The percent of test scripts that passed in the Tests worksheet.

System Requirements


If you have any questions, or have any issues with the Webtesting.io Web API Edition, please email us at info@webtesting.io for further assistance.

** By downloading the Webtesting.io JSON, means you agreed to our End-User Terms and Conditions