Table of Contents

Test Case
Definition The fundamental unit representing a single test scenario that can be executed independently. It consists of a .http file and optional supporting scripts that define setup, execution, and validation of API tests. Test cases can be grouped into a collection.
Purpose Encapsulates a single test scenario (not only) for isolated execution.
Example Usage Request File of a Complete Test Case

Structure

Request File

Each test case is represented by a .http file, referred to as the Request File. It must contain at least one HTTP request, following these conventions.

Optional Scripts

For more complex test cases, these additional scripts can be included:

  • Pre-Request Script – A .csx script for data setup and initialization before executing HTTP requests.
  • Post-Response Script – A .csx script for validating API responses and performing assertions - testing.

Additional Optional Files

When running a test case, you can also reference:

Running a Test Case

To execute a test case, run:

teapie <path-to-request-file>

To try it out, you can run a test case from the demo collection. The following test case is a good example as it demonstrates multiple features:

teapie "./Tests/002-Cars/002-Edit-Car-req.http"

For advanced usage, here’s the full command specification:

teapie test <path-to-test-case> [--temp-path <path-to-temporary-folder>] [-d|--debug] [-v|--verbose] [-q|--quiet] [--log-level <minimal-log-level>] [--log-file <path-to-log-file>] [--log-file-log-level <minimal-log-level-for-log-file>] [-e|--env|--environment <environment-name>] [--env-file|--environment-file <path-to-environment-file>] [-r|--report-file <path-to-report-file>] [-i|--init-script|--initialization-script <path-to-initialization-script>] [--no-cache-vars|--no-cache-variables]

💡 Tip: You can use the alias t or omit the command name entirely, since test is the default command when launching TeaPie.

To view detailed information about each argument and option, run:

teapie --help

Scaffolding

To create a new test case, use:

teapie generate <test-case-name> [path] [-i|--init|--pre-request] [-t|--test|--post-response]

💡 Shortcut: You can use aliases gen or g instead of generate.

This command generates the following files in the specified path (or the current directory if no path is provided):

To disable pre-request or post-response script generation, set the -i and -t options to false.

Exploring Test Case Structure

To inspect the structure of a test case without executing it, run:

teapie explore <path-to-request-file> [-d|--debug] [-v|--verbose] [-q|--quiet] [--log-level <minimal-log-level>] [--log-file <path-to-log-file>] [--log-file-log-level <minimal-log-level-for-log-file>] [--env-file|--environment-file <path-to-environment-file>] [-i|--init-script|--initialization-script <path-to-initialization-script>]

💡 Shortcut: You can use aliases exp or e instead of explore.

Edit this page