ReadyAPI

What's new in this version:

ReadyAPI 3.56.0
Conditional Match Enhancements:
- Conditional Match Deletion: Users can now delete items in Conditional Match configuration when applying a filter or using the search function
- Display and Export Conditional Match Requests as JSON: Users can now view Conditional Match requests in JSON format and export the structure to a JSON file. For more information, visit this page.
- Improved Import Configuration: Users can now configure the Import from File and Record from Traffic features to ignore headers, null parameters, empty objects, empty arrays, and empty strings. For more information, visit this page.
- R/R Pairs Import Success Confirmation: Users will now receive a confirmation when Request/Response pairs are successfully imported. For more information, visit this page.
- Signature Name Matching: Signature names are now automatically updated if reassigned to ensure consistency
- Signature Reordering: Users can now reorder signatures within the signature list, which can be useful when a ‘Size of’ value is specified for a field in a signature. For more information, visit this page.

General Enhancements:
- Move or Copy Virtual Actions: Users can now move or copy a Virtual Action from one Virtual Service to another, allowing for greater flexibility in managing Virtual Services. For more information, visit this page.
- Enhanced Regular Expression Handling: Regular expression handling has been updated to enhance security.
- External DTD Validation Disabled by Default: External DTD validation is now disabled by default to improve security while processing SOAP artifacts such as WSDLs, Requests, and Responses. However, users can enable it in Global Preferences if needed. For more information, visit this page.
- AWS Pricing Calculator Removed: The AWS pricing calculator has been removed from ReadyAPI 3.56.0
- Updated Javadocs: Java methods and classes (Javadocs) were updated to align with the changes in ReadyAPI 3.56.0. For more information, visit this page
- Library Updates: ReadyAPI 3.56.0 includes newer versions of some libraries that version 3.55.0 used. If your scripts refer to classes from these libraries, you might need to update the scripts.


ReadyAPI 3.55.0
Conditional Match Enhancements:
- Setting Date Delta Using Property Expansion: Conditional Match now supports setting Date Delta using Property Expansion. You can specify the default date format dd-MM-yyyy in Virtual Service Preferences, allowing responses to have dates relative to request dates. Property expansion and date offset syntax, including requestDateDelta and currentDateDelta, are applied to request and response fields with this format. For more information, visit this page.
- Selected Items Previewer: A new Selected Items Previewer in the Configure dialog for Conditional Match allows you to visualize relationships between signatures, requests, and responses. Select a signature, request, or response to see its related matches. For more information, visit this page.
- Array Parameter Size in Conditional Match: Users can now specify the size of array parameters in signatures. For more information, visit this page.
- Ignore Null/Empty Parameters in Conditional Match: Users now have the option to ignore null or empty parameters when matching signatures. For more information, visit this page.
- Aliases for Any and Empty Values in Conditional Match: Users can now use aliases for any and empty values in the Valid Value column when configuring a Conditional Match. The alias * represents any value, while _ signifies an empty value. For more information, visit this page.
- Default Response per Signature: You can now configure a default response for each signature. If an incoming request matches a signature but no specific response is found, the default response for that signature will be used. If no signatures match, the global default response will be sent. For more information, visit this page.

Integration Updates:
- SwaggerHub Integration: You can now use SwaggerHub as a source for API definitions when creating new tests or virtual services, as well as when updating and refactoring API definitions in tests. For more information on specific tasks, see:
User Interface Enhancements:
- Script Editing Confirmation: When you click the X button while editing a script, a confirmation window now prompts you to ensure changes aren't lost. This update helps prevent accidental closure and data loss.
- Popup Suppression for Encrypted Requests: A new system property, -Dsuppress.api.request.validation.message=true, has been added to suppress the popup that appears when viewing encrypted request content in the Project save/load scripts. This helps keep the encrypted content intact without interruptions. For more information, visit the JVM Options documentation.
- Default Dispatch Style for Virtual Services: You can now set a default dispatch style for Virtual Services in the Preferences window. By default, this is set to Sequence, but you can choose from additional styles including Random, Query Match, XPath, Script, Parameter, and Conditional Match. Access this setting under the Virtual Service Preference tab. For more information, visit this page.

General Enhancements:
- TCP Virtual Service Property Expansion: TCP Virtual Service responses now support property expansion, allowing results to dynamically adjust based on the request values sent.
- Restored WebLogic 12 Support: ReadyAPI has restored support for WebLogic 12 for versions up to ReadyAPI 3.51.0 and VirtServer 3.20.0. Ongoing work aims to extend this support in future releases. We will provide updates once full compatibility is achieved. For more details, see the WebLogic JMS configuration documentation.
- Assertion and Property Expansion Behavior: In ReadyAPI, both Assertion Contains and Property Expansions will pass when encountering an empty string (""), as it is always found within the response. Additionally, Smart Assertion behaves similarly when used inside structured data, so ensure your tests are configured to handle empty strings to avoid false positives.
- Character Encoding Support for Swedish Characters: ReadyAPI has been enhanced to correctly display Swedish characters (Å, Ä, Ö) when importing .properties files. This addresses a reported issue where these characters were not displayed properly. Users with Swedish locale settings will now experience improved character encoding support.
- Library Updates: ReadyAPI 3.55.0 includes newer versions of some libraries that version 3.54.0 used. If your scripts refer to classes from these libraries, you might need to update the scripts.


ReadyAPI 3.54.0
Conditional Match:
- We are introducing Conditional Match, a new dispatch style setting within ReadyAPI's Virtualization module. This feature offers enhanced control over how virtual services respond to requests, facilitating more realistic and dynamic testing scenarios. Learn more about Conditional Match here.

Functionality Improvements:
- ReadyAPI now allows fetching Avro/Protobuf key schema from a file

We added support for new custom Kafka test step properties:
- connectionSettings
- data
- channel
- endpoint
- schemas
- We have updated Swagger Compliance Assertion for OAS 3.1
- We have introduced Property Expansion support for the MQTT plugin

Integration Enhancements:
- We added support for Client ID and Client Secret from SLM On-premise License Server 2.0 to the Maven integration when using SLM on-premise

Plugin Updates:
- Client credentials for the SLM on-premise license server (version 2.0 or later) are now supported in both Jenkins Plugin version 1.11.0 and Azure Plugin version 2.1.8
- We have released version 1.6.6 of the ready-mqtt-plugin

General Updates:
- ReadyAPI 3.54.0 includes newer versions of some libraries that version 3.53.0 used. If your scripts refer to classes from these libraries, you might need to update the scripts.
- We updated the JDK to version 17.0.11


ReadyAPI 3.53.0
SLM On-premise License Server for OIDC/Okta:
- We added support for Client Credentials to TestRunners and Docker to facilitate SLM On-premise License Server 2.0 and later. This requires configuring the SLM On-premise License Server for OIDC/Okta for client credentials to work.

ReadyAPI Feature Enhancement:
- Users can use a file named readyapi-install.vmoptions to specify JVM options that ReadyAPI will incorporate post-installation. The file must be in the same directory as the ReadyAPI installer.
- In the ReadyAPI PKCE flow for logging into Virtserver, there is a timeout of 20 seconds. ReadyAPI waits for 20 seconds for the browser to open, for users to enter authorization credentials, and for Okta to redirect back to ReadyAPI. If this process exceeds 20 seconds, ReadyAPI displays the Login Screen again with the "Login with OIDC" button. This timeout value can be configured via the vmoption virtserver.oidc.login.timeout.

General Updates:
- We updated Spring to version 5.3.33


ReadyAPI 3.52.0
PKCE flow for OIDC:
- SLM Onpremise 2.0 now supports OIDC. When you configure OIDC and request a license from the SLM On-premise server, your login will undergo a PKCE flow. Remember, this requires SLM Onpremise License Server 2.0 with OIDC configured.
- Support for Client Credentials in TestRunners and Plugins will come in future releases.
- We added PKCE flow for users authenticating to VirtServer when VirtServer is configured for OIDC. This feature will be compatible with VirtServer 3.20.0 or later (3.20.0 releases at the end of April 2024).
- We added vmoptions parameter that disables basic auth for Auth Profile verification that caused some issues during PKCE login.

ReadyAPI Feature Enhancement:
- Some special characters like {, } will be replaced in automatically generated test case names based on request URLs due to compatibility issues with Groovy scripts
- By default, sniHostCheck is now set to false to prevent compatibility issues with the latest version of the Jetty library
- When selecting tags for custom arguments in TestRunner, you can now choose how to combine the tags using OR or AND operators

Improvements:
- We added a new vmoptions parameter to allow you to disable automatic product updates, product update notifications, and the option to check for updates
- We removed deprecated Windows .dll files that were used by the installer
- A warning will now appear when you close the script editor without saving changes
- We removed Optimizely, previously used for testing new features. Now, ReadyAPI startup should improve by approx. 10 seconds

General Updates:
- We updated TestEngine license location
- We updated the JDK to version 17.0.10
- ReadyAPI 3.52.0 includes newer versions of some libraries that version 3.51.0 used. If your scripts refer to classes from these libraries, you might need to update the scripts.

Note:
- It is recommended to skip version 3.52.0 if you're encountering the ReadyAPI freeze issue (RIA-21011) while retrieving the OAuth 2.0 token. The solution for this problem is not included in this version. Please wait for the next release for a fix.


ReadyAPI 3.51.0
Facilitated H2 Migration:
- We introduced a migration tool enabling users to smoothly transition to the latest version of the H2 database. For more details, refer to H2 Migration page.

ReadyAPI Feature Enhancement:
- We added the capability to bulk delete custom properties. Previously, users could only delete one custom property at a time. This enhancement enables users to select multiple items and perform a bulk action.

Improved:
- A warning is now displayed when deleting methods in ReadyAPI. It alerts users if the method they’re deleting is being used by any test steps.
- Users can no longer delete a request if it’s used by any existing test step. To delete such a request, it is required to modify test steps.
- In instances where ReadyAPI was unable to import a test step due to a missing request, a warning was previously shown separately for each test step. We have introduced an "OK to all" function, allowing users to close just one popup window for potentially many with larger projects.
- Note: We have identified some use cases where ReadyAPI Windows users required broader character encoding through UTF-8. To set encoding to UTF-8, you need to make one configuration change to binReadyAPI.vmoptions. Insert a new line at the end and add -Dfile.encoding=UTF-8. Save, close the file, and open ReadyAPI. For additional details on setting the encoding to UTF-8, refer to this page.


ReadyAPI 3.50.0
- Change log not available for this version


ReadyAPI 3.49.0
GraphQL API from Introspection Query:
- We implemented the capability to import GraphQL APIs from Introspection Query

Improved:
- In ReadyAPI, transaction logs can be downloaded from REST, SOAP, TCP, JDBC and JMS virtual services hosted in VirtServer
- Enhanced privacy by concealing sensitive information under sun.java.command

General Updates:
- We have fixed a few blocker vulnerabilities javasecurity:S6096 reported by Sonarqube
- ReadyAPI 3.49.0 includes newer versions of some libraries that version 3.48.0 used. If your scripts refer to classes from these libraries, you might need to update the scripts.


ReadyAPI 3.48.0
Enhanced Authentication:
- We introduced basic authentication with a username and password for SmartBear ID sign-ins. Click here to learn more

ReadyAPI Feature Enhancement:
- Added SSL support for AMQP
- Integrated JUnit 5 dependencies into the ReadyAPI project, allowing the creation of new tests using the latest JUnit version
- Optimized the authentication algorithm of automated scripts by extending the default time from 5000ms to 20000ms. Additionally, we added 5-second intervals to monitor authorization progress, enhancing the user experience and execution times of automated authorization.

General Updates:
- Upgraded the Jira plugin to version 1.6.5. For more information, refer to this link.
- Updated guava to version 32.0.1-jre in the axm repository
- Temporarily disabled the option to create a gRPC Virt Service


ReadyAPI 3.47.0
Match TCP Requests:
- ReadyAPI now offers the capability to match TCP requests using Groovy scripts, giving users greater flexibility and customization options. You can write scripts either for the entire TCP virtual service or for individual requests.

Jenkins Plugin:
- ReadyAPI Jenkins plugin is extended to support SLM on-premise license server as well as the Smartbear SLM server and follows the same license authentication logic as the Azure plugin

ReadyAPI Feature Enhancement:
- You can download the local transaction log for HTTP Virtual Services from the ReadyAPI UI
- We added an “Uninstall” button that allows you to properly uninstall the Trial SLM Offline License. By doing so, we make it easier to uninstall your trial license and either use it on another machine or replace it with a production license.

General Updates:
- ReadyAPI is updated to work with Java 17.0.7


ReadyAPI 3.46.1
- A Library update caused an issue for ProtectionLS floating license users while requesting a license. In this patch release, we have reverted to the original library.
- We made some improvements to enhance the in-product trial request experience
- You can now configure your Vmoptions file to prevent it from being updated or overwritten during ReadyAPI upgrades


ReadyAPI 3.46.0
Token Generation in AppDynamics:
- We now offer the option to connect to AppDynamics using Client Name, Client Secret, and Account Name to generate a Token from within ReadyAPI. This is in addition to the existing method of providing a Token directly.
- ReadyAPI Plugins

Maven Plugin:
- We updated the ReadyAPI Maven Plugin to support ID-based or SLM licenses. To use this feature, we have added support for specifying SLM server parameters - accessKey (-K), username (-U), and password (-V).

Azure Plugin:
- We updated the ReadyAPI Azure DevOps Plugin to support ID-based / SLM licenses

Jenkins Plugin:
We updated the ReadyAPI Jenkins plugin that now enables ReadyAPI tests to be run on Jenkins in three different ways:
- ReadyAPI Functional Testing plugin can now be used as a new Build step > ReadyAPI Test: Run functional Test (available from ReadyAPI 3.46.0 onwards)
- Jenkins Pipeline can now be used with the SoapUI Pro Pipeline step (available from ReadyAPI 3.46.0 onwards)
- Command-line runners can still be used, as before
- Starting from version 3.46.0, you can pass the Access Key as a "-K" parameter for the first two options listed above

ReadyAPI Feature Enhancement:
- If you set Access for Everyone on SLM on-premises, you no longer need to add Access Key credentials to your CLI command configuration for TestRunner, Performance Load Runner, Security Test Runner, and VirtRunner
- In that case, you can add the -D licenseApiAccessForEveryone=true flag to your CLI command
- Starting with ReadyAPI 3.46.0, SSL Connection parameters only require the CA Certificate as a mandatory field; the other fields are optional
- We updated the log4j logging functionality to prevent it from generating excessively large log files that could overrun available drive storage
- ReadyAPI now supports the setting and use of multi-value parameters as Media Type: multipart/form-data
- ReadyAPI 3.46.0 introduces the ability to configure an endpoint's proxy to not use any proxy and override the global proxy setting
- The configuration flag will be set to 'False/Unchecked' by default, indicating that the global proxy will not be ignored. However, when set to 'True/Checked', global settings will be ignored.
- The setting is automatically saved when the corresponding project is saved

Improvements:
- In response to an error encountered while importing AsyncAPI from SwaggerHub, we have improved the error handling message
- We updated the default name of the generated JUnit reports from “SoapUI Test Results“ to – “JUnit Test Report“
- We updated the log messages displayed in ReadyAPI for Load Agents to show the source of the log messages

General Updates:
- ReadyAPI is updated to work with Java 17.0.6
- The License Management page is now automatically updated with the latest version of ReadyAPI


ReadyAPI 3.45.0
Improved ReadyAPI UI VirtServer Panel:
We updated the ReadyAPI UI VirtServer Panel to improve the license expiry experience. If the license expires, the ReadyAPI VirtServer Panel will:
Enable the user to log into the VirtServer and view the:
- Virtual Service details
- Transaction Log
- Activity
- Metrics
- Display the “VirtServer license has expired” message
- Prevent the user from deploying virtual services by showing a corresponding error message

ReadyAPI Feature Enhancement:
- We have added support for 'Brotli' compression in ReadyAPI. You can configure ReadyAPI to use this compression in the ReadyAPI HTTP Preferences panel. Please see more details on how to enable this feature.
- The "Logout and release the licenses" button is now disabled when an offline license is installed for any ReadyAPI module. This update guides users to properly uninstall offline licenses to prevent them from remaining attached to the product and blocking other licenses.
- You can configure the Commit message to be deleted once you have committed your changes in the ReadyAPI Git Preferences panel

Update API Endpoints:
- When updating an API, ReadyAPI now allows users to specify whether or not they also want to update API EndPoints. This is done by checking a new checkbox labeled "Update the EndPoints of the API.
- By default, this checkbox is checked, and ReadyAPI behaves as it did before, updating the API's EndPoints
- If the checkbox is unchecked, the API's EndPoints will remain unchanged after the update

Improvements:
- We improved the main progress bar to ensure consistency across Load, Functional, and Security tests
- ReadyAPI now supports the import and usage of xlsm Excel file formats in data sources, with the same behavior as for xlsx files
- When using a specific value for the "content-type" metadata, ReadyAPI will now display the value in other test steps "content-type", saving time when filling out required parameters
- We updated ReadyAPI to allow the import of the latest Resolved AsyncAPI APIs from SwaggerHub. You can now filter the AsyncAPI APIs to be imported by selecting the "AsyncAPI" filter option

General Updates:
- We have fixed a few Security Vulnerabilities


ReadyAPI 3.44.1
- Fixes an issue affecting some users when activating trial licenses


ReadyAPI 3.44.0
VirtService Deployment:
- From now on, you can deploy the same VirtService on the same VirtServer multiple times in the ReadyAPI GUI by drag and drop. ReadyAPI will automatically create a copy of that service, assigning it a unique service ID and access port.

ReadyAPI Test Steps:
- We added Webhooks, a new 'Test Steps' type for testing your async REST APIs. Also, support is available for the same.
- Synchronization for Load Testing Virtual Services:
- We added a feature flag that configures the 'Synchronization for Load Testing Virtual Services' setting. Now, you can prioritize processing speed over accuracy according to your needs.

ReadyAPI Improvements:
- We improved the error message for saving a Test Case without a corresponding test suite. We made the text clear and easy to understand so you could respond appropriately.
- To improve the readability of Smart Assertions in the Assertions tab, we have changed the default name from "Smart Assertion" to "Smart Assertion - Received Metadata" or "Smart Assertion - Received Data", depending on the assertion type.

General Updates:
- We updated the ReadyAPI JPROD builds to use the latest JPROD version. For reference, please visit Productivity Protection - What's New in Protection.
- When you attempt to create/update a JDBC connection with a connection string containing an unsupported character such as '_', a warning will appear in the

ReadyAPI GUI and the ReadyAPI logs:
- From now on, you can import AsyncAPI 2.5.0 into ReadyAPI from file-based API definitions
- We have fixed a few Security Vulnerabilities


ReadyAPI 3.43.1
- ReadyAPI 3.43.1 is a Patch, released to address an important issue introduced in ReadyAPI 3.43.0. Some customers were restricted from using SmartBear-ID-based licenses with ReadyAPI and Virtual Machines. Now it is fixed.


ReadyAPI 3.43.0
Updated Plugins:
- Postman plugin (Fixed Vulnerability Security issue)
- GitHub – SmartBear/readyapi-postman-plugin

VirtService Deployment:
- From now on, you can deploy the same VirtService on the same VirtServer multiple times in the ReadyAPI GUI by drag and drop. ReadyAPI will automatically create a copy of that service, assigning it a unique service ID and access port.

Enhanced Offline Key Request Process:
- We streamlined the offline activation/deactivation key request process by using a web form instead of email. From now on, to activate/deactivate an offline license, please follow this link


ReadyAPI 3.42.2
Updated Plugins:
- Jira plugin – updated to support Jira 8.2 and 9.1
- AWS plugin (Fixed Vulnerability Security issue)


ReadyAPI 3.42.1
Fixed:
- an issue that prevented users from using the Git Pull feature in ReadyAPI. The issue was introduced in the 3.42.0 version
- three related security vulnerabilities reported in JRE (CVE-2022-21618, CVE-2022-21624, CVE-2022-21626) by upgrading to 17.0.5
- an issue that prevented some Load Agents from having up-to-date project data at runtime, thus causing agents to not start or to fail during their runtime
- Now, if a Mac user receives ReadyAPI Update notifications, ReadyAPI will recommend the appropriate build to install (Apple Silicon CPU or Apple Intel x86-64) based on the user’s platform. In this case, ReadyAPI will ask the user to confirm installation or to select another version.


ReadyAPI 3.42.0
- From 3.42.0, you can see the License Number and the Number of VUs corresponding to the license that you are about to install or that you have installed
- Added the possibility to stop a Load Test when one of its Data Sources is exhausted
- Added a new feature for the users to configure a Kafka subscriber to consume the messages published only after that subscriber was connected
- Added support for the users to invoke external test cases in isolation from within a Groovy script step. This will enable the users to use groovy scripts with shared resources in Load Test scenarios
- Created a public method (.getTestCaseCloneByName("Other Test Case Name")) to get a WsdlTestCase clone by its name in groovy scripts, allowing to invoke external test cases in isolation while running performance tests
- From this version, you can use and insert Property Expansions in the Authentication types via the Get Data menu
- The Jira plugin was updated to support the latest Jira versions (8.x and 9.2)
- Updated Security Patch for the OpenSSL 3.0.7
- New Security updates for the Jira, Postman, and AWS plugins
- Added support for OAuth2.0 for Kafka in ReadyAPI
- Updated the Navigation Panel in ReadyAPI Documentation to make it easier to find the most commonly used topics


ReadyAPI 3.41.1
- The 3.41.1 patch was released to fix an installer issue for macOS introduced in 3.41
- In ReadyAPI 3.41, an issue was identified for macOS Monterey/M1 users updating to the latest ReadyAPI version by following the in-app update notification, or by downloading the ReadyAPI Trial version from the Trial Page. It is an issue related to the installation of Java Toolkit which resulted from the upgrade to the latest Java 17.0.4 version. Only M1 users encountered this problem. This was resolved.


ReadyAPI 3.41.0
- ReadyAPI was updated to support Java 17.0.4 (from Java 17.0.2)
- ReadyAPI has replaced the ‘Master’ Git terminology with the ‘Main’ naming. This update applies to the Git repositories which will be used from now in ReadyAPI. The existing Git repositories will continue to use their existing names.
- You can now Search in the Navigator through Test Cases and Test Steps as well, not only through Test Suites
- Added the possibility to Save a Test Suite of a Composite Project. Saving a Test Suite will save all its Test Cases
- This is described further in Managing Test Cases and Managing Test Suites.
- The OAuth2 process is updated to enable the users to add the Audience parameter within the OAuth2 requests, as an optional parameter
- This is described further in Enabling OAuth 2.0 Authentication.
- Added vertical scroll bars to move more easily through the APIs for which you want to add a New Security Test for a Single Request
- Now, it is possible to Add/Remove multiple Agents in a Load Test, at the same time
- This is described further in Creating Distributed Load Tests.
- Improved the Error Message provided when trying to connect to a Virt Server by providing an URL in an invalid format
- The ‘Abort test if an error occurs’ is now set to Off by default, based on customers and community feedback


ReadyAPI 3.40.2
- Minor bugfix release that includes a few changes as compared to the previous version of the product