04. Swagger Import Definition

Why Was This Developed?

The Swagger Import Definition developed in Avo Assure leverages the capabilities of the Swagger framework for documenting REST APIs. Avo Assure aims to streamline the API integration and testing process by incorporating Swagger, making it more efficient and collaborative.

What is the Goal?

The Swagger Import Definition in Avo Assure aims to simplify the REST API integration and testing workflow. Utilizing the strengths of the Swagger framework, it aims to enhance efficiency and foster better collaboration in REST API-related projects. This initiative is focused on reducing complexity, automating processes, and providing a more intuitive, structured approach to REST API testing.

How Does It Work?

The Swagger Import Definition workflow is tailored to provide a seamless experience integrating and testing APIs within the Avo Assure environment. It encapsulates everything from initial setup to final response validation.

1. The user has to navigate to the Avo Assure home screen.

2. The user has to select the Web Services project from the All Project list.

3. The user has to click the Design Studio button, and the Design Studio window will be displayed.

4. The user has to click the Import Definition icon and the Import API Definition dialog box will be displayed.

5. The user has to enter the Source URL (Swagger URL) in the URL field.

6. The user has to select the Swagger from the Select Protocol drop-down menu and click the Import API button.

7. The Avo Assure client will create the Mindmap automatically, and click the Save button.

8. To get the screen context menu, the user has to click the Screen icon.

9. The user has to click the Element Repository button, and the Element Repository window will be displayed.

10. The Avo Assure Client will automatically generate the Request Header and Body, and the user must provide the required input.

11. To get the response, the user has to click the Request Body button.

12. From the required API, the user has to copy the Request Body input and paste the copied input into the Request Body field.

13. To fetch the data, the user has to click the Send button, and a toast message stating that Successfully fetched data will be displayed.

14. Once fetching data is completed, the user has to click the Response button to view the response.

15. The user can view the Response details in the Response Body.

16. The user can view the Response status in the Response Header.

How can I get this?

If the user upgrades to the latest version of Avo Assure to 24.0.1, this feature will be available automatically. If you are not part of this particular version, 24.0.1, contact [e-mail] to get this version.