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
next to the APIs node.
Show image
— or —
-
Right-click the APIs section in the Navigator and select Add API.
ReadyAPI will show the Add API dialog:
Click the image to enlarge it.
The dialog has the following tabs:
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:
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:
Swagger/OpenAPI Definition (REST)
-
Default Media Type - Specifies the media type that ReadyAPI will use for the requests in which no media type is specified.
GraphQL schema
-
Endpoint - Specify an endpoint to be added to the service’s endpoints.
WSDL Definition (SOAP)
-
Create sample requests for all operations - Creates sample requests for all WSDL operations.
-
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.
WADL Definition (REST)
-
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.
Click the image to enlarge it.
-
Select the needed HTTP method from the Method drop-down list.
-
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.
-
If you want to add more resources, click Add Endpoint and repeat the steps.
Tip: To remove the added endpoint, click 
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
ReadyAPI supports SwaggerHub SaaS and SwaggerHub On‑Premise 1.23.0-46 or later.
Use the SwaggerHub tab to import public or private definitions from SwaggerHub:
-
Select a definition or definitions that you want to add to your project.
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.
-
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.
-
-
Select versions of definitions that will be imported. The default version (marked with
) of the definition is selected by default:
Click the image to enlarge it.
-
Click Add API.
You can also publish your API definition to SwaggerHub or SwaggerHub On-Premise. See Export to SwaggerHub for details.
SwaggerHub connection issue
If you cannot connect to SwaggerHub using your credentials, try regenerating API keys in SwaggerHub:
-
Open the account settings in SwaggerHub:
-
Switch to the API Keys tab and click Regenerate:
Click the image to enlarge it.
-
Edit your SwaggerHub account info in ReadyAPI and enter the new API key:
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
New XML-RPC service from URL
To add an XML-RPC service to your project:
-
Right-click the APIs node and select New XML-RPC Service from URL:
-
In the subsequent dialog, enter your service
.remURL:
Click the image to enlarge it.
-
To create sample requests, select the Create Requests.
-
Click OK.