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 imageHide image
— or —
Right-click the APIs section in the Navigator and select Add API.Show imageHide image
ReadyAPI will show the Add API dialog:
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:
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.
Endpoint - Specify an endpoint to be added to the service’s endpoints.
WSDL Definition (SOAP)
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.
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.
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 SwaggerHubLog in to SwaggerHub
If you use SwaggerHub On-Premise, select Use on-prem URL and enter the URL of your SwaggerHub instance.
In the Username field, enter your SwaggerHub username.
Note: The SwaggerHub integration does not support logging in with a GitHub account.
In the API Key field, enter your API key.
Tip: If you click Get API Key, you will be taken to the SwaggerHub API Keys page in your web browser. You can copy your API key from there.
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 referenceFilter reference
Shows APIs that are marked as Public in SwaggerHub.
Shows APIs that are marked as Private in SwaggerHub.
Shows OpenAPI Specification ver. 2 (Swagger 2.0) definitions.
Shows OpenAPI Specification ver. 3 definitions.
Shows only the APIs that have already been added to the project.
Shows the APIs which have been added to the project and of which a new version is available in SwaggerHub.
Select versions of definitions that will be imported. The default version (marked with ) of the definition is selected by default:
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:
Edit your SwaggerHub account info in ReadyAPI and enter the new API key:
|Please note that, if you use these keys to access SwaggerHub’s public API, you need to update them in your code, as well.|