Import API Definition Interface and Functional Flow

The Import API Definition feature allows you to automatically generate multiple Webservice elements in the Element Repository from a provided API specification. Instead of manually configuring each request, Avo Assure analyzes the imported definition and creates the corresponding endpoints, significantly reducing setup time and ensuring consistency across large API collections.

This capability is particularly useful when working with services that expose multiple endpoints such as REST or SOAP based systems where rapid, bulk creation of Webservice elements helps accelerate API automation and testing.

You can import an API definition using the following options:

• File: Import an API definition file directly from the local system (e.g., Swagger, Postman Collection, or WSDL file).

• URL: Import the API definition from a hosted location by specifying the definition URL.

About the File Option

On the Element Repository page (Home > Select Project > Design Studio > Element Repository > Select Create Folder icon/Parent Folder (Ellipsis icon) > Import API Definition > File), you can do the following:

1. Import API Definition using File Option

   • Allows you to upload a local Swagger or Open API JSON definition file from their system.

   • After the API definition file is uploaded, Avo Assure parses the file and automatically creates API elements in the repository based on the endpoints defined in the specification.

   • This eliminates the need to configure each request manually and ensures the imported structure matches the original API contract.

About the URL Option

You can use the URL option to import an API definition directly from a hosted link.

On the Element Repository page (Home > Select Project > Design Studio > Element Repository > Select Create Folder icon/Parent Folder (Ellipsis icon) > Import API Definition > URL), you can do the following:

1. Import API Definition using URL Option

   • This method enables you to fetch the API specification using the definition URL provided in the Source Label text box.

   • The Protocol dropdown identifies the service type, which can be automatically defined or manually selected as WSDL for SOAP services or Swagger for REST services.

   • After the definition URL and protocol are configured, Avo Assure retrieves the API specification from the specified source and automatically generates the API elements in the Element Repository.