diff --git a/.github/assets/banner-dark.svg b/.github/assets/banner-dark.svg new file mode 100644 index 0000000..ac19d0f --- /dev/null +++ b/.github/assets/banner-dark.svg @@ -0,0 +1,37 @@ + + API Testing Framework. Typed API tests on Playwright's request API, with Zod contracts. PASS: Every response checked against a Zod schema. PASS: Cleanup fails the test if anything is left behind. WARN: Malformed POST /booking returns 500, expected 400. + + + + [03] of 07 · api-testing-framework + + API Testing Framework + Typed API tests on Playwright's request API, with Zod contracts + + $ npx playwright test --grep @contract + + + PASS + Every response checked against a Zod schema + + + + PASS + Cleanup fails the test if anything is left behind + + + + WARN + Malformed POST /booking returns 500, expected 400 + + $ + + diff --git a/.github/assets/banner-light.svg b/.github/assets/banner-light.svg new file mode 100644 index 0000000..03ea1b1 --- /dev/null +++ b/.github/assets/banner-light.svg @@ -0,0 +1,37 @@ + + API Testing Framework. Typed API tests on Playwright's request API, with Zod contracts. PASS: Every response checked against a Zod schema. PASS: Cleanup fails the test if anything is left behind. WARN: Malformed POST /booking returns 500, expected 400. + + + + [03] of 07 · api-testing-framework + + API Testing Framework + Typed API tests on Playwright's request API, with Zod contracts + + $ npx playwright test --grep @contract + + + PASS + Every response checked against a Zod schema + + + + PASS + Cleanup fails the test if anything is left behind + + + + WARN + Malformed POST /booking returns 500, expected 400 + + $ + + diff --git a/README.md b/README.md index e557de5..dec17be 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# API Testing Framework +

+ + + API Testing Framework: Typed API tests on Playwright's request API, with Zod contracts + +

[![CI](https://github.com/VincentJerico/api-testing-framework/actions/workflows/ci.yml/badge.svg)](https://github.com/VincentJerico/api-testing-framework/actions/workflows/ci.yml) ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) @@ -6,6 +11,8 @@ ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white) ![Zod](https://img.shields.io/badge/Zod-3E67B1?logo=zod&logoColor=white) +QA portfolio: [01 journey](https://github.com/VincentJerico/qa-engineering-journey) · [02 framework](https://github.com/VincentJerico/playwright-framework-template) · **03 api** · [04 taskflow](https://github.com/VincentJerico/taskflow-under-test) · [05 accessibility](https://github.com/VincentJerico/accessibility-testing) · [06 security](https://github.com/VincentJerico/security-testing) · [07 performance](https://github.com/VincentJerico/performance-testing) · [profile](https://github.com/VincentJerico) + A reusable, typed API test framework built on Playwright's `request` API. It's the layer I'd put between a test suite and a REST API. It has typed clients, contract checks with Zod schemas, auth handled by fixtures, realistic test data, and cleanup that fails the test if anything is left behind.