API Onboarding
Was this helpful?
Was this helpful?
To accommodate diverse project requirements, our platform provides three methodologies for creating APIs in your Test Suite. This flexibility ensures that you can select the approach most compatible with your workflow.
Step 1: From the dashboard click on playground.
Step 2: Click on Add API’s
One efficient method to create APIs is through URL imports. This process supports two primary formats: Swagger and WSDL*. Depending on your project's specifications, you can choose the format that best aligns with your requirements.
Using Swagger Format
Step 1: In the import section and click on "Swagger" if you're using the Swagger format for your API.
Step 2: Input the Swagger URL:
Type in the URL of your Swagger file in the provided field. To practice or see how it works, you example lets use https://petstore.swagger.io/v2/swagger.json. This is a sample URL that shows you how the process works with a real example.
Step 3: Click 'Continue':
This tells the platform to start fetching your API's details from the Swagger file you specified.
The platform will now take a moment to process the URL and add your API to your Test Suite. It reads the Swagger file and sets up your API so you can start working with it.
Step 4: Select all the Endpoints to add to testing and click on Add to test.
Once you've successfully imported your APIs using the URL method, the platform will navigate you to a comprehensive dashboard.
This dashboard is where you can manage all your imported APIs effectively.
Let's dive into how you can edit, create, delete, modify, and send these APIs to meet your project requirements.
Navigating Your API Dashboard
Upon arrival at the API dashboard, you'll notice the platform has organized your APIs neatly. Here's how to get started with managing them:
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. Once selected, look for the three dots (more options) next to the API name. Clicking here will reveal a menu with various actions you can perform.
Saving to Test Suite: To add an API to a specific Test Suite, first, click on 'Save to test Suite'.
A pop-up box will ask to name your Test Suite if you haven't already created one.
Do this by typing the name into the field provided and clicking the tick box to confirm.
If you've previously set up a Test Suite, simply select it from the dropdown menu to save your API there.
Cloning an API: Cloning is handy when you want to create a similar API with slight modifications. Select 'Clone' to make an exact copy of the selected API, which you can then edit as needed.
Sending an API: This option is useful for testing your API's functionality in real-time. Choose 'Send' to execute the API call and view the response, helping you to validate its performance.
We can also click on the send button highlighted in the image below.
It will open the response tab, showing:
Status: If request has been successfully processed by the server, It will show OK as a successful interaction and is the standard response for successful HTTPs requests.
Size: The total size of the response data sent from the server, including headers and body content. It gives an idea of the payload's weight, which can impact load times and performance, especially in data-intensive applications.
Time: The duration taken for the request to be sent, processed, and for the response to be received. It is a critical metric for assessing the efficiency and speed of the API, highlighting the system's responsiveness.
Users can review the body of the response, often shown in the format specified (such as JSON, XML, etc.), to assess the API's behavior and validate its output against expected results. This immediate feedback is crucial for debugging and optimizing API functionality.
Deleting an API: If an API is no longer needed or was added by mistake, selecting 'Delete' icon will remove it from your dashboard.
To add more API’s, click on the Add Icon.
Modifying API
Select an API: The main screen will display all its intricate details under the 'Details' tab. Here you can modify the API to fit your exact needs:
API Name and Type: Users can view the API's name and select its type (REST, SOAP) to ensure proper handling within the platform.
Method Selection: Users can designate the appropriate method (GET, POST, PUT, DELETE, PATCH) based on the desired action the API should perform, thereby defining its interaction with the server.
Timeout Setting: Users have the option to set a timeout in milliseconds.
Protocol Configuration: The platform facilitates toggling between HTTP and HTTPS protocols, allowing users to secure API calls by opting for HTTPS where applicable.
Endpoint and Context Path: Within this section, users can modify the API's endpoint URL and specify the context path, essential for directing API calls accurately.
Authorization Type: Users can select the authorization type that aligns with the API's security requirements, ensuring secure interactions, whether it involves Basic Auth or OAuth. The authorization will be generated when you save the API.
In the Headers and Params tab, users have the capability to add, delete, and modify both the key and value, as well as the type of each parameter. This functionality allows for precise customization and configuration of API requests, ensuring accurate and effective testing.
Within the Body tab, users encounter an array of options for inputting data. They can opt for either entering code directly or uploading a file.
When selecting the code option, users can specify the type of code they are inputting, with choices including JSON, XML, Text, or GraphQL.
The Test Cases tab, users are presented with options to define test cases for headers assertions, and the body of the API request or response. This functionality allows for thorough testing and validation of various aspects of the API's behavior, ensuring reliability and consistency in its performance.
Using WSDL Format
Step 1: Navigate to the Add API button and select "WSDL" if your API utilizes the WSDL format.
Step 2: Enter the WSDL URL:
Add the URL of your WSDL file. For a practical example or to familiarize yourself with the procedure, consider using a sample WSDL URL.
Step 3: Initiate Import by Clicking 'Continue':
Modifying API
Select an API: The main screen will display all its intricate details under the 'Details' tab. Here you can modify the API to fit your exact needs:
API Name and Type: Users can view the API's name and select its type (REST, SOAP) to ensure proper handling within the platform.
Method Selection: Users can designate the appropriate method (GET, POST, PUT, DELETE, PATCH) based on the desired action the API should perform, thereby defining its interaction with the server.
Timeout Setting: Users have the option to set a timeout in milliseconds.
Protocol Configuration: The platform facilitates toggling between HTTP and HTTPS protocols, allowing users to secure API calls by opting for HTTPS where applicable.
Endpoint and Context Path: Within this section, users can modify the API's endpoint URL and specify the context path, essential for directing API calls accurately.
Authorization Type: Users can select the authorization type that aligns with the API's security requirements, ensuring secure interactions, whether it involves Basic Auth or OAuth. The authorization will be generated when you save the API.
In the Headers and Params tab, users have the capability to add, delete, and modify both the key and value, as well as the type of each parameter. This functionality allows for precise customization and configuration of API requests, ensuring accurate and effective testing.
Within the Body tab, users encounter an array of options for inputting data. They can opt for either entering code directly or uploading a file.
In the code type for WSDL the system shows the XML code type.
The Test Cases tab, users are presented with options to define test cases for headers assertions, and the body of the API request or response. This functionality allows for thorough testing and validation of various aspects of the API's behavior, ensuring reliability and consistency in its performance.
Click on Add API and choose create manually option
Select the API type and give a name.
Click on Create API to begin the manual process.
Enter all the required details for the API.
API Name and Type: Users can view the API's name and select its type (REST, SOAP) to ensure proper handling within the platform.
Method Selection: Users can designate the appropriate method (GET, POST, PUT, DELETE, PATCH) based on the desired action the API should perform, thereby defining its interaction with the server.
Timeout Setting: Users have the option to set a timeout in milliseconds.
Protocol Configuration: The platform facilitates toggling between HTTP and HTTPS protocols, allowing users to secure API calls by opting for HTTPS where applicable.
Endpoint and Context Path: Within this section, users can modify the API's endpoint URL and specify the context path, essential for directing API calls accurately.
Authorization Type: Users can select the authorization type that aligns with the API's security requirements, ensuring secure interactions, whether it involves Basic Auth or OAuth. The authorization will be generated when you save the API.
In the Headers and Params tab, users have the capability to add, delete, and modify both the key and value, as well as the type of each parameter. This functionality allows for precise customization and configuration of API requests, ensuring accurate and effective testing.
Within the Body tab, users have two options for inputting data. They can opt for either entering code directly or uploading a file.
Enter a unique key name and upload the body, by uploading the file.
The Test Cases tab, users need to manually define test cases for headers assertions, and the body of the API request or response. This functionality allows for thorough testing and validation of various aspects of the API's behavior, ensuring reliability and consistency in its performance.
To manually upload the file click choose swagger or WSDL type, and upload the respective type of file and click on continue.
Note: Follow the same steps as for Import URL.
Note: If you want to know more about the Qyrus platform you can click on “know more” to learn about API, project-setup, functional-testing, API-process testing, Advanced-features and FAQs.
