Add schema validation example

Author: stefanjudis

api-schema-validation/.gitignore

@@ -0,0 +1,7 @@
+
+# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

api-schema-validation/.prettierrc

@@ -0,0 +1 @@
+{ "semi": true, "printWidth": 60 }

api-schema-validation/package-lock.json

@@ -0,0 +1,21 @@
+{
+  "name": "api-schema-validation",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "start": "node server.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@faker-js/faker": "^9.4.0",
+    "@playwright/test": "^1.50.1",
+    "@types/node": "^22.13.0",
+    "zod": "^3.24.1"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1"
+  }
+}

api-schema-validation/package.json

@@ -0,0 +1,48 @@
+import { defineConfig } from "@playwright/test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./tests",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: "http://127.0.0.1:8000",
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "API tests",
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: "npm run start",
+    url: "http://127.0.0.1:8000",
+    reuseExistingServer: !process.env.CI,
+  },
+});

api-schema-validation/playwright.config.ts

@@ -0,0 +1,76 @@
+const { faker } = require("@faker-js/faker");
+const http = require("node:http");
+
+const server = http.createServer({}, (req, res) => {
+  const url = new URL(
+    req.url || "/",
+    "http://localhost:8080"
+  );
+  const id = url.searchParams.get("id");
+
+  if (url.pathname === "/complex") {
+    res.writeHead(200, {
+      "Content-Type": "application/json",
+    });
+    return res.end(
+      JSON.stringify({
+        id: faker.string.uuid(),
+        name: faker.person.fullName(),
+        relatedPeople:
+          Math.random() > 0.5
+            ? Array.from({ length: 5 }, () => ({
+                id: faker.string.uuid(),
+                name: faker.person.fullName(),
+              }))
+            : null,
+      })
+    );
+  }
+
+  if (req.method === "GET") {
+    res.writeHead(200, {
+      "Content-Type": "application/json",
+    });
+    return res.end(
+      JSON.stringify({
+        id,
+        name: "Check Lee",
+      })
+    );
+  }
+
+  if (req.method === "POST") {
+    let body = "";
+
+    req.on("data", (chunk) => {
+      body += chunk.toString();
+    });
+
+    req.on("end", () => {
+      let parsedBody;
+      try {
+        parsedBody = JSON.parse(body);
+        console.log(parsedBody);
+      } catch (e) {
+        res.writeHead(400, {
+          "Content-Type": "application/json",
+        });
+        return res.end(
+          JSON.stringify({ error: "Invalid JSON" })
+        );
+      }
+
+      res.writeHead(201, {
+        "Content-Type": "application/json",
+      });
+      return res.end(
+        JSON.stringify({
+          id: faker.string.uuid(),
+          name: parsedBody.name,
+        })
+      );
+    });
+  }
+});
+
+server.listen(8000);