Quick Test the API

This section will help you quickly test APIs using a simple editor interface. By following these steps, you can easily evaluate API functionality, analyse responses, and identify potential issues.

How to test the API?

To quickly test the API endpoint, you have to first provide all the input parameters in the API editor. To learn how to user the editor to create API test case, refer to Create an API Test Case.

1. Pre-Requisites: Create the API step with the required input details of the endpoint in the API Editor.

2. Click the "Send" Button: Once you've configured the request, click the "Send" button to execute the API call.

3. Analyse the Response: Examine the response that appears in the designated area. This response includes:

   • Response Body: Data that is returned by the API in response to a request.

   • Status Code: Indicates the success or failure of the API call (e.g., 200 for success, 404 for not found).

   • Headers: Additional information about the response, such as content type or authentication details.

   • Body: The data returned by the API, which may be in various formats like JSON, XML, or plain text.

     The format of the response body can vary depending on the API's design and the specific request, but common formats include:

     • JSON (JavaScript Object Notation): A lightweight data-interchange format that is widely used in APIs.

     • XML (Extensible Markup Language): Another popular format for data exchange, often used in older APIs.

     • Plain text: A simple format for returning text-based data.

     • HTML (Hypertext Markup Language): Used for returning web pages or other HTML-based content.

When testing APIs, it's important to examine the response body carefully to ensure that it contains the correct data and is formatted as expected.