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.