Skip to Content
E2E Test AutomationFunctional TestingAPI Ad-hoc TestingAPI Schemas and Forms

📋 Overview of Schemas and Forms

Schemas and Forms are integral features of E2E Test Automation that simplify the process of interacting with API requests and testing them. These features are designed to enhance the flexibility, usability, and accuracy of your API testing workflows, especially when dealing with complex request bodies or dynamic data.

📖 Understanding Schemas and Forms

Schemas in E2E Test Automation

In E2E Test Automation, schemas define the structure of the request body in a clear and standardized format. Schemas are automatically generated from the body of the API request, enabling you to define and validate the data expected by your API.

Why Use Schemas?

  • Data Validation – Schemas help validate the structure of your request body, ensuring that all required fields are present and have the correct data types (e.g., string, number, boolean). This prevents sending invalid or incomplete data to the API
  • Consistency – With schemas, you maintain consistent API request bodies, which is particularly helpful when working with large teams or multiple environments (e.g., Development, Staging, Production)
  • Reusability – Once a schema is generated, it can be reused across different requests or test cases. This reduces redundancy and ensures that the same validation logic applies throughout your API testing

Example:

If your API request requires user details, the schema will specify fields like name, email, age, and their respective data types. By generating the schema from the request body, E2E Test Automation automatically captures the structure, ensuring that all variables are properly defined and validated.

Forms in E2E Test Automation

Forms take schemas a step further by converting them into an interactive, user-friendly layout. The Form View displays each variable in the request body as an input field (such as text boxes, dropdowns, or checkboxes) depending on the variable type defined in the schema.

Why Use Forms?

  • User-Friendly Interface – The form layout makes it easier for anyone (even non-developers) to fill out the request body without dealing with raw JSON or worrying about the correct format. It eliminates the need for manually typing JSON objects, reducing errors and streamlining the process
  • Dynamic Interactions – Forms allow you to interact with your API requests dynamically. For instance, selecting a value in a dropdown list or toggling a checkbox will automatically update the underlying request body
  • Intuitive Navigation – For more complex API requests that require nested data or arrays, E2E Test Automation’s Form View simplifies navigation by presenting hierarchical data in a clear, structured layout

Example:

In the Form View, if the request body requires fields like name, email, and age, each field will be presented as an individual form element. The user can easily enter values into these fields, and the request body is dynamically updated without the need for direct JSON manipulation.

🎯 Key Benefits

Efficiency and Speed

  • Schema Generation – Quickly generate schemas based on the request body, ensuring that complex data structures are validated without manual effort
  • Form View – Convert schemas into interactive forms, allowing for easy navigation and data input

Consistency

Schemas ensure that your API request body is consistent across environments, tests, and teams. With validated request structures, you avoid potential issues caused by incorrectly formatted data.

Reduced Errors

  • Schemas enforce validation rules (such as required fields or valid data types), making you less likely to send incorrect data to your APIs
  • The form-based interface makes filling out the request body easier, preventing errors that can occur when manually typing JSON

Collaboration-Friendly

Forms provide an intuitive interface for non-technical users to interact with APIs. This allows product owners, QA testers, and other stakeholders to review or modify API request bodies without needing to know the exact syntax of JSON.

Dynamic Data Management

Environment Variables and dynamic values can be incorporated directly into the form layout, making it easier to test different environments without manually changing the API request each time.

Seamless Execution

Once the form is completed, users can submit the data directly from the API Forms tab in E2E Test Automation. This allows you to save the request, and later execute it for testing purposes. The request is stored with the form’s data, and you can use the tree view or JSON view to examine and execute the form as needed.

🔄 How Schemas and Forms Enhance API Testing

By using Schemas and Forms in E2E Test Automation, you significantly improve the API testing workflow:

  • Schemas ensure your API request bodies are structured correctly, validated for accuracy, and reusable across tests
  • Forms provide an intuitive and interactive interface for both technical and non-technical users to input dynamic data into API requests, simplifying testing and collaboration

Together, these features streamline the testing process, reduce errors, and make it easier to interact with complex API requests.

✅ Summary

Schemas and Forms in E2E Test Automation offer a powerful and user-friendly way to manage and execute API requests. Whether you are generating schemas from request bodies, filling out forms for quick request submission, or validating data with built-in structures, E2E Test Automation helps ensure your API testing is streamlined, efficient, and accurate. These features make E2E Test Automation a versatile tool for API developers, testers, and non-technical users alike.

Happy testing! 🚀

Types of API Requests in E2EExecute API Requests in Form View
API Schemas and Forms | Documentation