API monitoring in AlertSite is powered by ReadyAPI, a testing tool for REST and SOAP APIs. ReadyAPI is the next generation of SoapUI by SmartBear. AlertSite uses multiple versions of ReadyAPI for backward compatibility and lets you choose a specific version to run your API monitors.
If you are monitoring ReadyAPI or SoapUI projects, we recommend that you create these projects using the same version of ReadyAPI as used in AlertSite. The version defines available functionality, such as the supported syntax for JSON assertions.
Global locations
Each AlertSite location has several versions of ReadyAPI installed:
-
ReadyAPI TestEngine 1.23 – an optimized test runner for ReadyAPI and SoapUI tests. This version functionally corresponds to ReadyAPI 3.8.
-
ReadyAPI TestEngine 1.7.0 – corresponds to ReadyAPI 2.8.
-
ReadyAPI 1.9
-
ReadyAPI 1.1
The default playback engine for API endpoint monitors is TestEngine 1.7, for SoapUI monitors – ReadyAPI 1.9. You can choose a different version in the monitor configuration:
AlertSite UXM
AlertSite 1.0
You can also choose a specific version when running tests on demand. This selection overrides the monitor’s Playback engine option.
AlertSite UXM
Click the image to enlarge it.
AlertSite 1.0
Click the image to enlarge it.
Notes:
-
If TestEngine 1.23 is selected but is not available at a location, TestEngine 1.7 is used instead.
-
The Playback Engine option is ignored when a monitor is run at Private Node Server locations. These locations use their locally available engine (see below).
Private locations
Private Node Server locations use the following versions of ReadyAPI:
| Private Node Server Version |
ReadyAPI Version |
|---|---|
| 3.1 and later |
TestEngine, ReadyAPI 1.9, and ReadyAPI 1.1. You can choose the version to use on the Configure > SoapUI Version screen in the location’s Control Panel. |
| 2.1—3.0.1 |
ReadyAPI 1.9 and ReadyAPI 1.1. You can choose the version to use on the Configure > SoapUI Version screen in the location’s Control Panel. |
| 1.6—2.0.2 | ReadyAPI 1.1 |
| 1.5.0 | SoapUI 4.5 |
InSite appliances prior to v. 1.5 do not support SoapUI monitors.
Viewing ReadyAPI version in monitor run results
The engine used during a monitor run is mentioned in the run log that is part of monitor run results:
================================
=
= READY_API_HOME = /usr/local/soapui
=
================================
...
Ready! API 1.9.0-m-SNAPSHOT TestCaseRunner Summary
-----------------------------
Time Taken: 505ms
Total TestSuites: 0
Total TestCases: 1 (0 failed)
...
The engine that was used during tests on demand is displayed at the top of the results screen:
Click the image to enlarge it.
See Also
Creating an API Endpoint Monitor
Create API Monitor From SoapUI Test