Applies to ReadyAPI 2.4, last modified on June 7, 2018

After you create a project, your API may change. Usually, you can automatically update the definition by re-importing the API definition file, but you may also choose to update it manually. You can find information about how to expand your API in this topic.

Add new APIs

To add a new API to the project without creating a new one, right-click the project in the Navigator panel and select the suitable option:

API testing: Adding APIs to an existing ReadyAPI project

Add WSDL

The Add WSDL command of the context menu appends a SOAP service based on a WSDL specification to your project. In the dialog that is invoked after you select the command, you specify the URL or file name of your WSDL specification and configure the import parameters:

Adding the new SOAP API from WSDL

Click the image to enlarge it.

Option Description

WSDL Location

The path to the definition file.

Create Requests

If selected, ReadyAPI will create sample requests for all WSDL operations.

Create Test Suite

If selected, ReadyAPI will create a test suite with test cases for each operation in WSDL.

Create Virtual Service

Creates a virtual API based on the imported WSDL.

Add WADL

You use the Add WADL command to add a REST API based on a WADL specification to your project. In the subsequent dialog, you specify the URL or file name of your WADL specification and select Create TestSuite :

Adding the new REST API from WADL

Click the image to enlarge it.

Import Swagger/OpenAPI definition

You use this command to add an OpenAPI- or Swagger-based REST service to your project. In the dialog that appears after you select the command, you can specify the URL or file name of your OpenAPI or Swagger specification. Both YAML and JSON specification formats are supported:

Adding the new REST API from Swagger definition

Click the image to enlarge it.

The value you enter in the Default Media Type edit box specifies the media type that ReadyAPI will use for the requests in which no media type is specified.

Import from SwaggerHub

You use this command to import both public and private API definitions from SwaggerHub. In the dialog that appears after you select the command, log in to your SwaggerHub account and search for the needed definition:

Importing an OpenAPI (Swagger) definition from SwaggerHub

Click the image to enlarge it.

To use this feature, you need to have the Swagger plugin, which is not bundled with ReadyAPI. See Installing Plugins to learn how to install the plugin.

You can also publish your API definition to SwaggerHub. See Export to SwaggerHub for details.

New REST service from URL

This command appends a new service to your project and adds only one HTTP request to it. You specify this request URL in the dialog that appears after you select the command:

Adding the new REST Service from URL

Enter the full URL, including the protocol, host name and parameters. The host name will become the service name in the Navigator tree. The resource path will become the resource name. ReadyAPI will also read query parameters and add them to a new request in the UI.

You may encode non-alphanumeric characters in the URL (for example, type %20 instead of spaces), or you may leave these characters as they are: ReadyAPI will read them correctly in both cases.

New XML-RPC service from URL

You use this command to add an XML-RPC service to your project. In the dialog that is invoked after you select the command, enter your service .rem URL. Select the Create Requests check box to create sample requests, if needed:

Adding the new XML-RPC Service from URL

Click the image to enlarge it.

Extend REST APIs

REST APIs offer a large degree of customization. You can add any element to the existing definition:

  • Resource – Right-click the needed service to add the resource to and select New Resource. In the subsequent dialog, enter the resource path and method.

    Tip: You can also add a resource to the existing one. To do this, right-click the resource and select New Child Resource.
  • Method – Right-click the resource and select New Method.

  • Request  – Right-click the method and select New Request.

Extend SOAP APIs

In SOAP API, the WSDL defines the operations. To add or remove operations, you need to import a new WSDL. You can add requests from the Operations page in the interface editor, or right-click the operation and select New Request.

See Also

Refactoring REST APIs
About ServiceV
SOAP Interface Operations Page

Highlight search results