Readyapi download

ReadyAPI DocumentationInstallationInstall ReadyAPI from the Command LineThis page explains how to install ReadyAPI from the command line.For a typical installation process, see the Installation Guide.To learn how to install VirtServer, see VirtServer Installation.Before installationTo run ReadyAPI, your computer must meet certain system requirements.Also, you will need either a ReadyAPI trial license or a commercial Pro license for one or all ReadyAPI tools (ReadyAPI Test, ReadyAPI Performance, ReadyAPI Virtualization). A Pro license for one of the tools enables the basic functionality of the other ones.Before the first ReadyAPI run, you need to install a license.For current ReadyAPI users:If you have an active license of ReadyAPI, you do not need to activate a new license.VirtServer requires a separate license.Ubuntu prerequisitesImportantIf you install ReadyAPI on the Ubuntu operating system, you should run the following command to avoid an error during the installation:sudo apt-get install fontconfigDownload installerVisit the ReadyAPI Downloads Center and download the ReadyAPI Linux installer of the desired bitness. This package includes JDK, so you can use it on a machine without installing Java. To install ReadyAPI on a headless machine, follow the instructions below.To download a package on a headless machine, you can use curl or a similar tool:Installation stepsThe following instruction describes the process of installing ReadyAPI on a headless machine.Prepare the installation file:Run the installer with the -c argument:If ReadyAPI is already installed on your computer, you will be asked whether you want to update the current installation or install the product anew to a different directory.After the installation is complete, you can run ReadyAPI command-line tools to run tests:TestRunnerAbout Security TestRunnerAbout Performance TestRunnerAbout Automating Virtual Service RunsCommand-line argumentsBelow is a short list of command-line parameters you can use to install ReadyAPI on a headless machine. For the complete list of parameters, see install4j help.-h, -help, or /?: Displays the list of available command-line arguments.-manual: Commands the installer to act as if no JRE has been found and displays the dialog where you can choose a JRE or download one if a JRE has been bundled dynamically. If you locate a JRE, it will be used for the installed tool.ImportantYou can apply this parameter to Microsoft Windows only.-c: Executes the installer in the console mode, that is, the interaction with the user is performed in the terminal from which the installer was invoked.-q: Executes the installer in the unattended mode, that is, there is no interaction with the user, and the installation is performed automatically with the default values.-g: Executes the installer in the GUI mode.TipUse this parameter if you configured the installer default execution mode as the console or unattended one.-console: Displays the installer output, if the installer is executed in the unattended mode and the -console parameter

ReadyAPI DocumentationCustomization in ReadyAPIPlugin DevelopmentDeveloping PluginsCreating a ProjectInstallTo create a basic project from the Maven archetype:Run the following maven command from the command line or terminal:mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.smartbear -DarchetypeArtifactId=ready-api-plugin-archetype -DarchetypeCatalog= Archetype Plugin v. 3.0.0 does not support the archetypeCatalog parameter. To use this plugin version, configure settings.xml as described in the Maven Archetype Plugin documentation.This will download the archetype from the SmartBear repository and start the project creation process.You will be prompted to provide the following:groupId : the groupId to be used in the generated pom.xml, for example, "com.mycompany";artifactId : the artifact set in the generated pom.xml, for example, "my-readyapi-plugin";version : the initial version of your plugin, defaults to "1.0-SNAPSHOT";package : the package where your plugin code will be generated, defaults to the specified groupId;language : the language to generate for, specify either java or Groovy;type : the type of the plugin you want to generate. For a list of plugin types supported by the archetype, see ReadyAPI Plugin Archetype.You will then be prompted to confirm your values:Enter y and press Enter.A skeleton plugin will be generated.

ReadyAPI DocumentationPerformance TestsBest PracticesRunning Load Tests from MavenIf you are using Maven in your development environment, you can include ReadyAPI Performance tests in your builds. To do so, you command Maven to download and use the ReadyAPI Maven plugin in your project.RequirementsTo run load tests from Maven, you need to have the following on the computer, where you are going to run a Maven build:A pom.xml file with a reference to the ReadyAPI Maven pluginReadyAPIYour ReadyAPI project fileYou do not need to configure your environment specifically for running load tests, and any required dependencies will be handled by Maven.Pom FileMaven reads details about the build from the pom.xml file. You need to configure it to get the ReadyAPI plugin from the Maven repository and add a load test to the test phase of the build lifecycle.You can find a sample Maven configuration below. If you already have your own configuration, copy the necessary elements to it.Running Load TestTo start the load test, use the Maven test command in the folder with your pom.xml file. This command will run the load test and generate reports for it. For example:C:/Work/MvnSample> mvn testIf your tests use the Maven SureFire plugin to create reports, use the site command instead.C:/Work/MvnSample> mvn siteSample Maven Load TestBelow is a sample pom.xml file that runs the Baseline-load-test-project.xml project. You can find this project in the folder. To use the sample:(Optional) Start virtual service from the project. This step is not required, but having a running virtual service will provide meaningful results.Create a new pom.xml file and copy the sample code to it. Make sure to specify the same version as the ReadyAPI version you have.Place the Baseline-load-test-project.xml project file in the folder where the pom.xml file is located.Run the Maven build by using the mvn site command as described above.You can specify additional properties of the load test by removing comments on unused elements and entering the parameters.If you already have a pom.xml file, copy the elements to it to include a load test in the build. 4.0.0 com.mycompany.app my-app 1.0 SmartBearPluginRepository com.smartbear ready-api-maven-plugin 1.6.1 test loadtest Baseline-load-test-project.xml Baseline Load Test (Geocoding) PDF true Maven Surefire reports. Must be as shown. --> in. --> ${basedir}/target/surefire-reports true :: (for example, 60:0:200)--> this value.--> =--> if the runner terminates requests running at the moment the test is stopped.--> if the load is simulated from the local computer.--> false, configured agents are used.--> scenario) --> =--> =--> in the test run.--> Information on Plugins UsedThis example uses the Maven Surefire Plugin to generate JUnit XML reports and the Maven Site Plugin to improve test stability. Depending on the changes to the plugins, you may need to change the pom.xml file. For

ReadyAPI DocumentationReadyAPI LicensesFile-Based LicensesHeadless MachinesActivate Fixed Licenses on Headless MachinesImportant Notice for ReadyAPI CustomersReadyAPI has fully transitioned to the ID-based SmartBear License Management (SLM) system. We are now moving into the final phase of deprecation of file-based licenses. Customers still using file-based licensing need to plan for migration to SLM before September 30, 2025.If you are still in the process of migrating or have yet to start, contact your Account Manager or SmartBear representative today. Our teams are ready to assist with smooth transition strategies. For additional support, please log a request with our Customer Care Team, who are standing by to help.For further information and timelines, please refer to this page.You can activate licenses on headless machines by using a command-line license manager.Download the License Manager packaged application from the SmartBear website.NoteThe License Manager requires Java 12. You can use Java shipped with ReadyAPI or download the required version from the License Manager .bat (or .sh on Linux and macOS) file with the -f option:For example, if you use Java shipped with ReadyAPI, perform the following commands:cd \jre\bin\license-manager.bat -f C:\work\ReadyAPITestLicense.keyIf you use Java 12 installed in your operating system, perform the following command:license-manager.bat -f C:\Work\ReadyAPITestLicense.keyNoteUse license-manager.sh on Linux and macOS.The License Manager will ask you to choose the activation mode (Online or Offline).If your computer can access enter 1 to select online activation.If your computer does not have an Internet connection, enter 2 to select offline activation.Online activation procedureIf you select online activation, the License Manager will ask you to provide the following credentials:TitleFirst nameLast nameCompany nameAddressCityStateCountryZip codePhone numberE-mailAfter you specify your credentials, the License Manager will activate the license.Offline activation procedureOffline activation is usually used when the computer you want to activate ReadyAPI on does not have Internet access. When you select offline activation, the License Manager displays text like this one:License Number: [2023-01-01 00:00:00] SUIP-1Y-SBN-NL - 83262bd2-7e0d-4ae8-bfd3-97d24ef22386 Activation Key: 9DEFC-5NMDE-8U5GJ-KE8F7-G3VQ8ImportantDo not close the License Manager window until you complete the activation.Please go to the offline activation/deactivation page, choose the ‘Activate License’ action, and fill in the form with the License Number and the Activation Key. The SmartBear

The startup, shutdown, Before Request, and After Request scripts to perform initialization, cleanup, or dispatch and handle requests to the virtual API.Create load and save scripts that will trigger when you open or save your project respectively.Store scripts common for your projects in Groovy Script libraries and reuse them whenever you want.Generate data for test cases with data source scripts.Save the test case run data with data sink scripts.Generate property values dynamically with DataGen script properties.You can find some examples of script usage in the Groovy Scripting Samples section.Supported languagesCurrently, ReadyAPI supports the following languages:You can select the scripting language to be used in the project properties. We recommend using Groovy scripts in your tests, since ReadyAPI offers code completion and debugging of Groovy scripts.Libraries and script collectionsScripting editors in ReadyAPI give you access to several types of scripting objects:Libraries that come pre-installed with ReadyAPI, including a number of standard Groovy and Java classes.External Java libraries that you can add if the pre-installed libraries do not satisfy your needs.Custom collections of Groovy scripts that you can create and reuse throughout your projects.To learn more about customizing your scripting needs, see the Script Libraries section.ImportantReadyAPI uses a number of third-party libraries. It is quite possible that we will update some of these libraries or even remove them from ReadyAPI. If you use classes from these libraries, you will have to update your scripts. See a list of third-party libraries updated in ReadyAPI 3.48.Object referenceScripting also allows you to access objects of