Applies to ReadyAPI 3.4, last modified on October 26, 2020

Your project may interact with more than one API. This topic explains how you can add more APIs to your project.

Add API dialog

You add APIs in the Add API dialog. To open it:

  • Click Plusnext to the APIs node.

    Show image

— or —

  • Right-click the APIs section in the Navigator and select Add API.

    Show image

ReadyAPI will show the Add API dialog:

Add API to ReadyAPI project

Click the image to enlarge it.

The dialog has the following tabs:

Definition

Use this tab to add API from a definition file: Swagger/OpenAPI, GraphQL, WSDL, or WADL.

Endpoint

Use this tab to add REST API by using its resources URLs.

Discover API

Use this tab to record requests while you are working with the service.

SwaggerHub

Use this tab to add API directly from SwaggerHub.

Add API by using definition file

In the Definition tab, you can add APIs by using API’s definition: Swagger/OpenAPI, GraphQL, WSDL, or WADL.

Note: You can also import definitions from SwaggerHub. See how to do it below.

Specify the address of the definition file in the URL or File Path field and click Add API:

Add API to ReadyAPI project

Click the image to enlarge it.

ReadyAPI defines the definition type automatically. If you need to specify advanced options, select the needed type manually from the Type drop-down list.

Below, you can find descriptions of the Advanced options for different definition types:

  • Default Media Type - Specifies the media type that ReadyAPI will use for the requests in which no media type is specified.

  • Create sample requests for all operations - Creates sample requests for all WSDL operations.

    Example

  • Create a test case for the imported WSDL - Generate test cases for each operation in WSDL.

  • Create a virtual service for the imported WSDL - Creates a virtual API based on the imported WSDL.

  • Create a test case for the imported WADL - Select this option if you want ReadyAPI to generate a test case.

New REST service from Endpoint

Use the Endpoint tab to append a new REST service to your project and add the specified request to it.

Adding a new REST Service from an endpoint

Click the image to enlarge it.

  1. Select the needed HTTP method from the Method drop-down list.

  2. Enter the full URL, including the protocol, hostname, and parameters to the Endpoint field. 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.

  3. If you want to add more resources, click Add Endpoint and repeat the steps.

    Tip: To remove the added endpoint, click Remove next to it.

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.

Import from SwaggerHub

Use the SwaggerHub tab to import public or private definitions from SwaggerHub:

  1. Select a definition or definitions that you want to add to your project.

    Create project from SwaggerHub: Select definitions

    Click the image to enlarge it.

    • My API contains APIs created by or shared with the SwaggerHub account that you have added to ReadyAPI. If you haven't added an account, click Log In to SwaggerHub.

      Log in to SwaggerHub

    • Public API contains all the APIs in SwaggerHub that you have access to.

    Tip: Use search and filter functionality to find the APIs you need.

    Filter reference

  2. Select versions of definitions that will be imported. The default version (marked with ) of the definition is selected by default:

    Create project from SwaggerHub: Select version

    Click the image to enlarge it.

  3. Click Add API.

You can also publish your API definition to SwaggerHub or SwaggerHub On-Premise. See Export to SwaggerHub for details.

If you cannot connect to SwaggerHub using your credentials, try regenerating API keys in SwaggerHub:

  1. Open the account settings in SwaggerHub:

    SwaggerHub integration: Account settings
  2. Switch to the API Keys tab and click Regenerate:

    SwaggerHub integration: Regenerating API keys

    Click the image to enlarge it.

  3. Edit your SwaggerHub account info in ReadyAPI and enter the new API key:

    SwaggerHub integration: Edit account info

    Click the image to enlarge it.

Please note that, if you use these keys to access SwaggerHub’s public API, you need to update them in your code, as well.

Other ways to add APIs

To add an XML-RPC service to your project:

  1. Right-click the APIs node and select New XML-RPC Service from URL:

    SwaggerHub in ReadyAPI: Importing SwaggerHub definition
  2. In the subsequent dialog, enter your service .rem URL:

    Adding the new XML-RPC Service from URL

    Click the image to enlarge it.

  3. To create sample requests, select the Create Requests.

  4. Click OK.

See Also

Extend Existing APIs
Organizing APIs

Highlight search results