Configuration Page
Last updated
Last updated
The API configuration page for automation testing is utilized for managing:
Default Configuration
Environment
URL
Http Header
Autherization
Cleanup Reports
Rename/Delete Test Component
Move Your Test Scripts
Upload File to Server
The configuration page can be accessed by navigating to Automation > API Testig > Configuration from the left navigation panel.
The default configuration functions as the default configuration for a web page. Please review the details for the Configuration page under the Web Testing section, accessible through the following path: https://qabunch.gitbook.io/qaautomater/web-automation/configuration-page.
The "Environment" section is used for adding new environment names, and it can also be utilized for deleting existing environment names.
To add a new environment, click on the "Add" button. A new row will be added; enter the name and click on the "Save" button. The new environment name will be saved on the server.
To delete an existing environment name, please follow these steps:
a. Select the radio button next to the environment you want to delete.
b. Click on the "Delete" button.
c. After that, click on the "Save" button.
In the URL section, we can add a URL for a specific environment. In today's scenarios, the same environment (e.g., QA) may call multiple microservices, each with a different base URL. Therefore, we can add all the base URLs in this section for a given environment and save them to the server. If your application has only one base URL throughout, then add only that single URL
To add a URL, first, select the environment from the listbox, and then click on the "Add" button. A new row will be added. If your baseURL is the same across the entire application, you can provide a generic name, for example, "baseURL," in the component section. Provide the URL in the URL column, and click on the "Save" button. The information will be saved into the server.
In the case where multiple microservices are called for the same environment (e.g., QA), such as different URLs for the login page, product list page, and shopping cart page, add multiple rows and provide all the URLs against their respective components. Afterward, click the "Save" button to store the information in the server.
Once it is saved on the server, it can be viewed on the API test script page.based on nature of test script we can select component URL
To delete a URL for a specific environment, please follow these steps:
a. Select the Environment.
b. Choose the radio button for the row containing the URL you want to delete.
c. Click on the "Delete" button.
d. After that, click on the "Save" button.
The URL information will be deleted from the server.
Generally, the HTTP header key is constant for all endpoints except for file downloads. The idea behind adding an HTTP header section is to include common HTTP header keys for all requests. This ensures that the creation of API test scripts will automatically incorporate these header keys into the test scripts.
We recommend placing common header keys in your API endpoints' HTTP headers.
For adding the common header key, click on the "Add" button, enter the header key name and its value, and then click the "Save" button. The information will be saved on the server.
All HTTP header keys configured will be displayed in the API test script page under Request header section.
To delete a header key from the HTTP header section, please follow these steps:
a. Select the radio button for the header key you want to delete.
b. Click on the "Delete" button.
c. After that, click on the "Save" button.
The header key will be deleted from the server.
In API testing, the need for login credentials arises when the API being tested requires authorization to access its functionalities. When interacting with certain APIs, particularly those that involve user-specific data or perform actions on behalf of a user, a valid set of login credentials, such as a username and password, API
For an API that requires authorization through a username and password, you can save these credentials on the configuration page. Subsequently, these authorization details can be utilized in the API test script page.
For adding the Authorization key, click on the "Add" button, provide the key name and other details, and then click on the "Save" button.
On the Test script page, we can consume it by key name.
To delete a key from the Autherization table section, please follow these steps:
a. Select the radio button for the key you want to delete.
b. Click on the "Delete" button.
c. After that, click on the "Save" button.
The autherization key will be deleted from the server.
The functionality of cleaning up reports is the same as in web testing. Please follow the link. https://qabunch.gitbook.io/qaautomater/web-automation/configuration-page.
The functionality of Rename/Delete test component is the same as in web testing. Please follow the link. https://qabunch.gitbook.io/qaautomater/web-automation/configuration-page.
The functionality of Move your test scripts test component is the same as in web testing. Please follow the link. https://qabunch.gitbook.io/qaautomater/web-automation/configuration-page.
This section is used for sending a local file to the server. Once it is saved on the server, you can then use the filename when the file needs to be sent in an API request.
