API Onboarding

The Qyrus API Testing Platform provides three methodologies for creating APIs in your Test Suite, ensuring flexibility and compatibility with your existing workflows.

Importing APIs

Swagger Format

1. In the import section, click on "Swagger" if you're using the Swagger format for your API.

2. Input the Swagger URL: Type in the URL of your Swagger file, or use the example URL https://petstore.swagger.io/v2/swagger.json to practice.

3. Click "Continue": This will initiate the process of fetching your API's details from the specified Swagger file.

4. Select the endpoints to add to testing and click "Add to test".

Once imported, you can manage your APIs from the comprehensive dashboard.

Navigating Your API Dashboard

• Accessing Your APIs: On the left side of the screen, you'll find a list of all your imported APIs. This list is your gateway to individually manage each API.

• Exploring API Options: Click on any API from the list to select it. Look for the "more options" menu (three dots) to reveal actions you can perform.

• Saving to Test Suite: Click "Save to Test Suite" to add an API to a specific Test Suite.

• Cloning an API: Select "Clone" to make an exact copy of the selected API, which you can then edit as needed.

• Sending an API: Choose "Send" to execute the API call and view the response, helping you validate its performance.

• Deleting an API: Select "Delete" to remove an API from your dashboard.

• Modifying API: Select an API to view and modify its details under the "Details" tab, including API name, type, method, timeout, protocol, endpoint, and authorization type.

• Headers and Params: In the "Headers and Params" tab, you can add, delete, and modify headers and parameters.

• Body: In the "Body" tab, you can input data by entering code directly or uploading a file.

• Test Cases: In the "Test Cases" tab, you can define test cases for headers assertions and the body of the API request or response.

WSDL Format

1. Navigate to the Add API button and select "WSDL" if your API utilizes the WSDL format.

2. Enter the WSDL URL: Add the URL of your WSDL file or use a sample URL for practice.

1. Initiate Import by Clicking "Continue".

Modifying API

Follow the same steps as modifying a Swagger API to customize the API details, headers, parameters, body, and test cases.

Postman Format (Pro Model)

1. In the playground, click "Add API".

2. Click on "Postman" and upload the URL (e.g., https://alexwohlbruck.github.io/cat-facts/).

3. Initiate Import by Clicking "Continue".

Note: Follow the same steps as for Import URL. And use Nova AI for generating test cases.

Manual API Creation

1. Click "Add API" and choose the "Create Manually" option.

2. Select the API type and provide a name.

3. Click "Create API" to begin the manual process.

4. Enter all the required details for the API, including headers, parameters, body, and test cases.

Test Suite Creation

1. Select the API(s) and click "Save to Test Suite".

2. Name your Test Suite or select an existing one.

1. Navigate to the Test Suite section.

2. Preview and execute the APIs within the Test Suite.

By following these steps, you can seamlessly onboard your APIs, customize their configurations, and organize them into Test Suites for efficient testing and validation.