e2e-testing

Document Playwright guidelines for end-to-end HTTP API tests.

Updated Mar 1, 2026
One-click install
npx skills add https://github.com/Zoppy-crm/.github --skill e2e-testing-zoppy-crm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: e2e-testing
Source: https://github.com/Zoppy-crm/.github/tree/main/skills/e2e/e2e-testing
Command: npx skills add https://github.com/Zoppy-crm/.github --skill e2e-testing-zoppy-crm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide codifies rules and patterns to create consistent, maintainable end-to-end HTTP API tests for the zoppy-e2e-api project, reducing flaky tests and speeding up onboarding for new test authors.

Core Features & Use Cases

  • Target Scope: Focuses on endpoints not consumed by the frontend, including Partners API, public webhooks, internal PVT services, and analytics queries (Segment/OpenSearch).
  • Authentication & Fixtures: Documents global login flow and Partners ExternalToken usage plus shared fixtures and HTTP client utilities.
  • Test Patterns: Describes validation tests, not-found checks, full CRUD flows, smoke checks for hard-to-test endpoints, and serial execution when order matters.
  • Operational Guidance: Defines project layout, status code conventions, environment variable requirements, and recommended commands to run the suite and generate reports.

Quick Start

Create an e2e Playwright spec for the partners customers endpoint that authenticates with the partners fixture, performs a create-read-update-delete flow, and asserts expected status codes and response shapes.

Frequently Asked Questions about e2e-testing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write reliable Playwright API E2E tests for backend endpoints?

Reliable Playwright API E2E tests require defining a project structure, authentication flows, test categories like validation and CRUD, and strict status code expectations to validate HTTP-level behavior consistently. This approach reduces flaky tests and speeds up onboarding.

What is the best way to test public webhooks and Partners API endpoints not consumed by the frontend?

Testing public webhooks and Partners API endpoints involves using specific test patterns like not-found checks and smoke tests, applying ExternalToken authentication, and validating HTTP status code conventions to ensure backend endpoint reliability.

How do I set up authentication flows for Playwright E2E API testing?

Setting up authentication for Playwright E2E API testing involves configuring a global login flow and utilizing Partners ExternalToken authentication, alongside shared fixtures and HTTP client utilities, to access protected endpoints during test execution.

What test categories should I include when creating E2E HTTP API tests?

E2E HTTP API tests should include validation tests, not-found checks, full CRUD flows, and smoke checks for hard-to-test endpoints, applying serial execution rules when test order matters to maintain consistency across the suite.

Do I need specific environment variables to run a Playwright E2e API test suite?

Yes, running a Playwright E2E API test suite requires specific environment variables to be configured, which define operational settings and authentication credentials needed to execute the tests and generate reports correctly.

When should I use serial execution rules in Playwright API testing?

Serial execution rules in Playwright API testing should be applied when test order matters, such as during full CRUD flows where subsequent read, update, or delete operations depend on the successful completion of prior create operations.