From 7689330bcef64abd588b0a154537b15870249fd2 Mon Sep 17 00:00:00 2001 From: Vincent Jerico Alcuran Date: Sun, 25 Oct 2026 10:09:45 +0800 Subject: [PATCH 1/2] docs(readme): add a test-run banner and links to the other QA repos Co-Authored-By: Claude Opus 5.5 --- .github/assets/banner-dark.svg | 35 +++++++++++++++++++++++++++++++++ .github/assets/banner-light.svg | 35 +++++++++++++++++++++++++++++++++ README.md | 9 ++++++++- 3 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 .github/assets/banner-dark.svg create mode 100644 .github/assets/banner-light.svg diff --git a/.github/assets/banner-dark.svg b/.github/assets/banner-dark.svg new file mode 100644 index 0000000..1359c87 --- /dev/null +++ b/.github/assets/banner-dark.svg @@ -0,0 +1,35 @@ + + 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..20aeecb --- /dev/null +++ b/.github/assets/banner-light.svg @@ -0,0 +1,35 @@ + + 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. From 5d0a80e7e82c384def98f7f49cc212ca9f415c34 Mon Sep 17 00:00:00 2001 From: Vincent Jerico Alcuran Date: Sun, 25 Oct 2026 10:11:23 +0800 Subject: [PATCH 2/2] docs(readme): show banner lines even where SVG animation doesn't run Co-Authored-By: Claude Opus 5.5 --- .github/assets/banner-dark.svg | 6 ++++-- .github/assets/banner-light.svg | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/assets/banner-dark.svg b/.github/assets/banner-dark.svg index 1359c87..ac19d0f 100644 --- a/.github/assets/banner-dark.svg +++ b/.github/assets/banner-dark.svg @@ -1,11 +1,13 @@ 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. diff --git a/.github/assets/banner-light.svg b/.github/assets/banner-light.svg index 20aeecb..03ea1b1 100644 --- a/.github/assets/banner-light.svg +++ b/.github/assets/banner-light.svg @@ -1,11 +1,13 @@ 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.