TeaPie.Tool 1.7.0

TeaPie - API Testing Framework

TeaPie is a lightweight API testing framework designed for automation-friendly, scriptable API testing with .http and .tp files. It provides pre-request scripting, post-response validation, retry strategies, flexible authentication, environments support and custom test directives.

📖 Documentation

📚 Complete documentation is available in the Wiki.

🚀 Features

✅ Universal HTTP Requests Definition – Define HTTP requests using .http files

✅ Flexible Test Structure – Use multi-file (.http + .csx) or single-file (.tp) format based on your needs

✅ Pre-Request & Post-Response Scripts – Extend HTTP request with C# scripts for data

✅ Custom Authentication Providers – Supports OAuth2 & user-defined authentication providers

✅ Retry Strategies – Customize retry logic for API failures

✅ Environment Support – Run your tests on any environment and change it dynamically

✅ Custom Reporting - Apart of Console and JUnit XML reporting, you can specify own reporters

✅ Easy Versioning – Collections of the tests can be part of (backend) repository and changes are easily visible on PRs

✅ Extensible & Open Source – Project is ready-to-be extended due to its pipeline design pattern

📦 Installation

Install via NuGet

To install TeaPie CLI, use the following command:

dotnet tool install -g TeaPie.Tool

To install the framework in your project:

dotnet add package TeaPie

🤖 AI Agent Skills

TeaPie provides AI Agent Skills that help AI assistants work more effectively with your tests. If you already have TeaPie installed, add skills to your project using:

teapie install-skills

This will download skills into .claude/skills/teapie/ in your project. For more details, see the AI Agent Skills documentation.

⚡ Quick Start

Create a new test case:

teapie generate <test-case-name>

Run all test cases in a collection:

teapie test demo

Execute a single test case:

teapie test ".\demo\Tests\002-Cars\002-Edit-Car-req.http"

Or run a single-file test case (.tp):

teapie test ".\demo\Tests\002-Cars\004-Car-Operations.tp"

For more usage details, visit the Wiki.

🤝 Contributing

We welcome contributions! Please check out the Contribution Guide for details on how to get involved.

📝 License

TeaPie is licensed under the MIT License. See the LICENSE file for details.