The SOAtest Smart API Test Generator enables you to capture traffic and create API tests from interactions with a web application. In this section:

Overview

The SOAtest Smart API Test Generator includes the following components:

SOAtest Traffic Recorder: The traffic recorder is an extension for the Chrome browser. It is installed on the local machine and provides an interface for configuring your connection to SOAtest, as well as starting/stopping recording.
Parasoft SOAtest Web Proxy: The proxy is installed on the local machine, processes traffic, and creates a .tst file in SOAtest.
Parasoft Root Certificate Authority: The CA enables HTTPS traffic to be recorded.

The Smart API Test Generator connects to a SOAtest desktop or server, which enables you to configure and run the test.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > soatest-smart-api-test-generator-overview.png

Browser Extension Requirements

SOAtest desktop or server 9.10.5 or later
Latest version of Google Chrome

Licensing

You can freely download and install the Smart API Test Generator, but a valid license for the Advanced Test Generation license feature in SOAtest is required to record traffic and generate tests. The following license options are available:

Advanced Test Generation Desktop: Enables you to create assets from the web proxy on the same machine where SOAtest is installed. Connections from remote machines are not allowed.
Advanced Test Generation 5 Users: Up to five users can create assets from any machine that can connect to the SOAtest server.
Advanced Test Generation 25 Users: Up to 25 users can create assets from any machine that can connect to the SOAtest server.
Advanced Test Generation 100 Users: Up to 100 users can create assets from any machine that can connect to the SOAtest server.

Contact your Parasoft representative for additional licensing information.

Installation

Run the parasoft_soatest_smart_api_test_generator_<version>_win32.exe file for installation on Windows or the parasoft_soatest_smart_api_test_generator_<version>_macos.dmg for installation on Mac OS. If Mac OS can not run the .dmg for security reasons, right-click the file and choose Open With> Installer.

Follow the wizard for your OS to complete the installation. See Manual Installation if you experience issues using the installer.

During Windows installation, you will be prompted to install the Parasoft SOAtest Web Proxy as a Windows service. This enables you to start and stop the proxy using the services console under the Windows Control Panel, as well as use the SOAtest Web Proxy console in the Windows Start menu (see Starting the Web Proxy). You can also manually start the proxy by running the executable JAR file (see Manually Starting the Web Proxy).

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-test-gen-installer-ms-service.png

The Windows and Mac installer will also prompt you to install the SOAtest Traffic Recorder from the Google Chrome store (Windows shown). See Manual Installation if access to the Google Chrome store is prohibited or if you experience issues using the installer.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-test-gen-installer-chrome-store.png

The installer will prompt you to install the Parasoft Root Certificate Authority if it is not detected. The CA is required to record traffic over HTTPS. The CA is normally installed along with the SOAtest/Virtualize desktop application. You can also add the CA manually (see Installing the Parasoft Root Certificate Authority).

During installation on Mac OS, you can enable the web proxy to automatically start whenever you log into the machine.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-installer-mac-autostart.png

You can enable or disable automatic start up for the web proxy after installation by in the System Preferences> Users & Groups> Login Items settings.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > web-proxy-macos-settings.png

You can click the padlock icon to view the Apple developer ID certificate authority (CA). The certificate identifies Parasoft as a trusted source of software for Apple devices.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-installer-mac-view-apple-cert.png

After the installer finishes, you will be prompted to enable the extension when you launch Chrome.

This action will uninstall and blacklist the extension. As a result, you will not be able to install or update the extension automatically.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-test-gen-installer-enable.png

The installer will prompt you to start the Parasoft SOAtest Web Proxy when the installation completes. If you choose to finish the installation without starting the proxy, see Starting the Web Proxy for instructions on starting the proxy on demand. If the proxy is running, see Using the Browser Extension for next steps. The SOAtest server must be running before you can use the extension.

Uninstalling the Browser Extension and Proxy

Use the regular Windows program uninstaller in the control panel to fully uninstall the tool. The Mac OS installer ships with an Uninstall SOAtest Smart API Test Generator utility that you can run if you wish to completely uninstall the tool. The Mac OS utility will be located in your Applications/Parasoft folder.

Manual Installation

The following instructions describe how to manually install the SOAtest Smart API Test Generator components if you are unable to use the Windows installer.

Download the TrafficRecordingExtension.zip folder (contact your Parasoft representative).
Extract the contents of the compressed folder anywhere on your machine. No additional installation is necessary to run the Parasoft SOAtest Web Proxy.
Open a Chrome browser window and open the Extensions page (chrome://extensions).
Enable the Developer mode option and click Load unpacked extension.
Navigate to and choose the [TrafficRecordingExtension_INSTALL]/chrome-extension directory to install the extension. The tool will be available in the browser bar.

The Parasoft SOAtest Web Proxy and SOAtest server must be running before you can use the extension (see Starting the Web Proxy). If the SOAtest server is running and the default configuration is used to start the proxy, you will be able to start using the extension to record traffic. See SOAtest Smart API Test Generator Usage if these components are running. You will also need to configure connections to the Parasoft SOAtest Web Proxy and SOAtest server once the browser extension is installed.

Installing the Parasoft Root Certificate Authority

The Parasoft Root Certificate Authority must be installed as a trusted certificate to enable recording of HTTPS traffic. If the certificate authority is not installed, the browser will not consider the connection secure and may refuse to allow the connection.

Windows

The Parasoft Root Certificate Authority is normally installed automatically by both the SOAtest Windows installer and the SOAtest Smart API Test Generator installer. You can also run the soatestcli with the -installcertificate option to manually install it if necessary. For example:

soatestcli -installcertificate

If SOAtest is not installed on the local machine, you can manually add the certificate to Chrome:

Open the Chrome settings page (chrome://settings) and expand the Advanced section.
Click Manage certificates in the Privacy and security section.
Click the Trusted Root Certification Authorities tab in the Certificates dialog.
Click Import to click Next when the Certificate Import Wizard opens.
Browse to the [TrafficRecordingExtension_INSTALL]/parasoft.cer file and click Next.
Verify that the wizard will place the certificate in the Trusted Root Certification Authorities folder and click Next.
Click Finish and confirm that you want to add the Parasoft Root Certificate Authority if prompted.

Mac OS

Open the Chrome settings page (chrome://settings) and expand the Advanced section.
Click Manage certificates in the Privacy and security section. The Keychain Access application will open.
Choose login under Keychains and choose Certificates under Category.
Choose File> Import items and navigate to parasoft.cer in the [TrafficRecordingExtension_INSTALL] directory.
Right-click the Parasoft Root Certificate Authority when it appears and choose Get Info.
Expand the Trust section and choose Always Trust from the When using this certificate drop-down menu.
Enter your credentials when prompted to save the configuration.

Starting the Web Proxy

If you installed the Parasoft Web Proxy as a Windows service, you can use the SOAtest Web Proxy console to start and stop the proxy.

Choose SOAtest Web Proxy from the Windows Start menu or double-click the desktop icon (if you chose this option during installation).
Click Start in the General tab.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > smart-api-test-gen-man-web-proxy.png

The web proxy API will be started on port 40090 by default. The proxy port used for recording will be assigned by scanning for open ports starting with port 40443. You can configure port numbers and other options when starting the proxy in the web proxy console. See Advanced SOAtest Smart API Test Generator Configuration for additional information.

Open the console and click Stop to shutdown the proxy.

On Mac OS, the web proxy will be located in your Applications/Parasoft folder.

SOAtest and Virtualize 9.10.6 with CTP 3.1.2 > Getting Started with SOAtest Smart API Test Generator > start-web-proxy-macos-ui.png

Manually Starting the Web Proxy

The web proxy is a JAR file that you can run with the java command:

%INSTALLDIR%/jre/bin/java -jar com.parasoft.traffic.proxy.jar

The Smart API Test Generator ships with its own instance of Java, but you can use any Java 8 or later that is already installed on your system.

The web proxy API will be started on port 40090 by default. The proxy port used for recording will be assigned by scanning for open ports starting with port 40443. You can specify system properties to configure port numbers and other options when starting the proxy. See Advanced SOAtest Smart API Test Generator Configuration for additional information.

Checking the Web Proxy Version

Execute the JAR file with the --version argument (-v shorthand) to print the version number on the command line. Example:

java -jar com.parasoft.traffic.proxy.jar --version

The version number can be helpful if you need to troubleshoot issues with the SOAtest Smart API Test Generator.

Executing the JAR with this argument only enables the proxy to report the version and does not start the proxy.

See Advanced SOAtest Smart API Test Generator Configuration for additional information.

Configuring the Browser Extension

Right-click the Parasoft icon and choose Options to open the configuration settings. You can also access the configuration settings by clicking the Options link on the chrome://extensions homepage.
Specify the proxy API port (See Advanced SOAtest Smart API Test Generator Configuration) and SOAtest server connection settings.

Enable the Secure (HTTPS) option to communicate with SOAtest over HTTPS.
Click Test Connection to verify your settings and click Save if successful.