ReadyAPI

Applies to ReadyAPI 3.51, last modified on March 19, 2024

This topic describes the options specific to ReadyAPI.

To configure the options:

  1. Click on the ReadyAPI toolbar.

  2. Select ReadyAPI in the left part of the ReadyAPI Preferences window and configure the needed options.

The available options and their descriptions are in the table below.

Option Description
Default SOAP request editor

Sets the default message editor to use when a SOAP request is opened.

Default REST request editor

Sets the default message editor to use when a REST request is opened.

Default response editor

Sets the default message editor to use when a response is received.

Outline and Overview editors limit, Characters

Defines the maximum size of messages to handle in the outline and overview editors.

Form editor limit, Characters

Defines the maximum size of messages to handle in the form editor.

Table inspector columns

Sets the maximum number of columns displayed in the table panel.

Script library

The path to the directory containing Groovy object scripts that should be available globally.

Custom Java libraries

Libraries that will be added to the classpath during the ReadyAPI start.

Click Add File to add a single JAR file. Click Add Folder to add a folder with JAR files. In this case, all JAR files located in the folder and its subfolders will be added to the classpath.

To remove a file or folder, select it in the list and click Remove.

If you add or remove libraries, the changes will take effect during the next ReadyAPI start.

Complete error logs

If selected, ReadyAPI logs complete error messages to reports on errors.

Custom report library

The path to the directory containing custom Jasper templates or reports.

By default, the option is empty. If no path is specified, ReadyAPI uses the default report folder (<ReadyAPI installation folder>/bin/reports).

Note: To apply the changes to this option, either restart ReadyAPI, or open the Reporting window and click the Reload all global reports and templates from disk button.
Allure Reports If selected, ReadyAPI collects data that is required for generating Allure reports.
Cache WSDLs and WADLs If this option is true, ReadyAPI stores the web service definitions in a local cache to avoid unnecessary loading when you open your projects and work with them. If the option is false, the definitions will be loaded from their location every time you open a project in ReadyAPI.
The option affects the following definitions:
  • WSDL
  • WADL
  • OpenAPI and Swagger definitions included in your project in ReadyAPI 2.2 and later

The option does not affect RAML definitions and Swagger definitions included in your project in ReadyAPI 2.1 and earlier.

See Also

Configuring Requests
Working with Projects
Preferences

Highlight search results