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.
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:
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:
The path to the definition file.
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.
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 :
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:
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.
Use this command to import both public and private API definitions from SwaggerHub.
In the dialog:
If you use SwaggerHub cloud service, use the predefined URL.
-- or --
If you use SwaggerHub On-Premise, select the Use on-prem URL check box. After that, specify the URL of your SwaggerHub On-Premise instance in the URL edit box.
Log in to your SwaggerHub account by entering the account credentials in the Login and Password fields.
|You can log in to SwaggerHub using only your SwaggerHub account, not a GitHub one.|
Select the Remember me check box if you want to save your SwaggerHub account information.
Enter the name, owner, title, or description of the needed definition in the Search field and click Search.
|Tip:||The Search field is case-insensitive. Multiple words, for example,
Select the My APIs only check box to filter out the search results.
Select a definition in the table. If the definition has multiple versions, select the needed one in the Versions column.
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.
Open the account settings in SwaggerHub:
Switch to the API Keys tab and click Regenerate:
|Please note that if you use these keys to access SwaggerHub’s public API, you need to update them in your code as well.|
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:
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.
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.
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.