Add CI workflow for Playwright API tests

Author: hoggu-sudo

.github/workflows/playwright.yml

@@ -3,20 +3,27 @@ name: Playwright API Tests
 on:
   push:
     branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
 
-    - name: Install Node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 18
+      - name: Install dependencies
+        run: npm install
 
-    - run: npm install
-    - run: npx playwright install --with-deps
+      - name: Install Playwright browsers
+        run: npx playwright install --with-deps
 
-    - run: npx playwright test
+      - name: Run API tests
+        run: npx playwright test tests/api

README.md

@@ -1,5 +1,9 @@
 # Playwright TypeScript API Automation Framework
 
+![CI](https://github.com/hoggu-sudo/playwright-ts-api-framework/actions/workflows/playwright.yml/badge.svg)
+
+# Playwright TypeScript API Automation Framework
+
 A production-style API automation framework built using **Playwright + TypeScript**, designed to demonstrate scalable test architecture, reusable API abstractions, validation layers, payload builders, and end-to-end workflow validation.
 
 ---

package-lock.json

@@ -11,12 +11,16 @@
     "report": "playwright show-report"
   },
   "keywords": [],
-  "author": "",
+  "author": "Hemasundar Oggu",
   "license": "ISC",
   "devDependencies": {
-    "@playwright/test": "^latest",
-    "@types/node": "^latest",
-    "ts-node": "^latest",
-    "typescript": "^latest"
+    "@playwright/test": "^1.53.0",
+    "@types/node": "^22.15.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "xlsx": "^0.18.5"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
   }
-}
+}

package.json

@@ -1,12 +1,13 @@
 import { defineConfig } from '@playwright/test';
+import path from 'path';
 
 export default defineConfig({
   testDir: './tests',
   timeout: 30000,
   fullyParallel: false,
   reporter: [['html'], ['list']],
   use: {
-    baseURL: 'https://reqres.in',
+    baseURL: 'https://dummyjson.com',
     extraHTTPHeaders: {
       'Content-Type': 'application/json'
     }

playwright.config.ts

@@ -1,18 +1,19 @@
 import { request, APIRequestContext, APIResponse } from '@playwright/test';
-import { ENV } from '../../config/env';
-import { Logger } from '../../utils/logger';
+import { ENV } from '@config/env';
+import { Logger } from '@utils/logger';
 
 export class BaseClient {
   private requestContext!: APIRequestContext;
 
-  async init() {
-    this.requestContext = await request.newContext({
-      baseURL: ENV.BASE_URL,
-      extraHTTPHeaders: {
-        'Content-Type': 'application/json'
-      }
-    });
-  }
+async init(token?: string) {
+  this.requestContext = await request.newContext({
+    baseURL: ENV.BASE_URL,
+    extraHTTPHeaders: {
+      'Content-Type': 'application/json',
+      ...(token ? { Authorization: `Bearer ${token}` } : {})
+    }
+  });
+}
 
   private ensureInitialized() {
     if (!this.requestContext) {
@@ -44,7 +45,10 @@ export class BaseClient {
     this.ensureInitialized();
     Logger.logRequest('POST', endpoint, body);
 
-    const response = await this.requestContext.post(endpoint, { data: body });
+    // const response = await this.requestContext.post(endpoint, { data: body });
+    const response = await this.retryRequest(() =>
+    this.requestContext.post(endpoint, { data: body })
+    );
     const data = await this.parseResponse(response);
 
     Logger.logResponse(response.status(), data);
@@ -79,4 +83,18 @@ export class BaseClient {
   async dispose() {
     await this.requestContext?.dispose();
   }
+
+  private async retryRequest(fn: () => Promise<any>, retries = 2) {
+  let attempt = 0;
+
+  while (attempt <= retries) {
+    try {
+      return await fn();
+    } catch (error) {
+      if (attempt === retries) throw error;
+      console.log(`Retrying request... attempt ${attempt + 1}`);
+      attempt++;
+    }
+  }
+}
 }

src/api/clients/baseClient.ts

@@ -1,5 +1,5 @@
-import { BaseClient } from './baseClient';
-import { UserPayload } from '../models/user.types';
+import { BaseClient } from '@api/clients/baseClient';
+import { UserPayload } from '@api/models/user.types';
 
 export class UserClient {
   private baseClient: BaseClient;

src/api/clients/userClient.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export const UserResponseSchema = z.object({
+  id: z.number(),
+  firstName: z.string(),
+  lastName: z.string(),
+  age: z.number()
+});