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

Back to Documentation Home Page

New version is available, Click here to learn more

Overview

Webtesting.io is a data-driven, automated API testing solution that allows developers and testers to create automated tests for JSON Web Services. Webtesting.io uses Microsoft Excel as the front-end client to manage the automated test scripts, identify expected results, capture the actual results, obtain API response times, and track historical test metrics for each test cycle. 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 URL The Target API's endpoint URL.
C HTTP Verb Identify the appropriate HTTP Verb to run the test. All HTTP Verbs are supported including: POST, GET, DELETE, PATCH.
D 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.
E Expected Name The expected name is the name of the JSON element being tested.
F Expected Value The expected value is the anticipate value. This is the primary driver for the Pass/Fail result
G Actual Value The actual value is data returned from the JSON API response.
H Pass/Fail The comparison of the Expected Value and Actual Value columns.
I Last Ran The date/time is automated test's date timetamp.
J Actual Response From API The actual "raw" JSON response from the Web Service.
K Actual Response Time The actual API response time in seconds (broken down in milliseconds).

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.

Getting Started (Creating Your First Automated API Test with Webtesting.io)

Objective: Create an automated test for an exchange rates API.

  1. Download the Webtesting.io JSON API Automated Testing software, which is a Microsoft Excel Macro-Enabled Worksheet. Click here to download.

  2. Open the software in the same manner you would open any Microsoft Excel Spreadsheet. Please make sure to enable macros for this spreadsheet, if prompted.

  3. Once the spreadsheet is opened, create a test case called Test Exchange Rate API - Success equals TRUE enter this value in the Test Name cell.

    Webtesting.io API Automated Test Name

  4. Enter https://www.vineos.io/api/currency/convert?source=USD&target=MXN in the Target URL cell.

    Webtesting.io API Tests Target URL

  5. Enter GET in the HTTP VERB cell.

    Webtesting.io API Automated Testing - HTTP GET VERB

  6. Leave the JSON Document (HTTP POST Only) cell empty since are not performing an HTTP POST.

    Webtesting.io API Automated Testing - GET ONLY

  7. Enter success in the Expected Name cell.

    Webtesting.io API Automated Testing - Expected JSON Name

  8. Enter TRUE in the Expected Value cell.

    Webtesting.io API Automated Testing - Expected JSON Value

  9. Click on the Run Tests button found in the Webtesting.io Excel Tab.

    Webtesting.io API Tests Worksheet

  10. Review the results: The Actual Value cell should contain the value TRUE.

    Webtesting.io API - Actual Value

  11. The Pass/Fail cell should contain the value PASS since the Expected Value cell equals the Actual Value cell.

    Webtesting.io API - Pass/Fail Value

  12. The Last Ran cell should record this automated test's official timestamp.

    Webtesting.io API - Timestamp

  13. The Actual Response From API cell should contain the actual JSON response from the exchange rates API.

    Webtesting.io API - Actual Response

  14. The Actual Response Time contains the actual API response time in seconds (broken down in milliseconds).

    Webtesting.io API - Actual Response Time

  15. Congratulations, you have successfully created your first automated test with Webtesting.io!

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