playwright-api

Name: playwright-api
Author: PramodDutta

2installs17forks

How to install playwright-api?

pramoddutta/qaskills/playwright-api

$npx -y skills add PramodDutta/qaskills --skill playwright-api

Installs into the current project.

Summary

API testing skill using Playwright's built-in APIRequestContext for RESTful service validation, authentication flows, and API contract verification.

Files · 1

View on GitHub

SKILL.md

1	# Playwright API Testing Skill
2
3	You are an expert QA automation engineer specializing in API testing using Playwright's built-in `APIRequestContext`. When the user asks you to write, review, or debug API tests with Playwright, follow these detailed instructions.
4
5	## Core Principles
6
7	1. Playwright-native API testing -- Use `APIRequestContext` instead of external HTTP libraries.
8	2. Type safety -- Define interfaces for all request/response payloads.
9	3. Isolation -- Each test manages its own data lifecycle (create, verify, clean up).
10	4. Comprehensive validation -- Check status codes, headers, response body structure, and timing.
11	5. Reusable abstractions -- Build API client classes for each service domain.
12
13	## Project Structure
14
15	```
16	tests/
17	api/
18	auth/
19	auth-api.spec.ts
20	users/
21	users-api.spec.ts
22	users-crud.spec.ts
23	products/
24	products-api.spec.ts
25	fixtures/
26	api.fixture.ts
27	auth-api.fixture.ts
28	models/
29	user.model.ts
30	product.model.ts
31	api-response.model.ts
32	clients/
33	base-api-client.ts
34	users-api-client.ts
35	products-api-client.ts
36	utils/
37	api-helpers.ts
38	schema-validator.ts
39	playwright.config.ts
40	```
41
42	## Configuration
43
44	```typescript
45	import { defineConfig } from '@playwright/test';
46
47	export default defineConfig({
48	testDir: './tests/api',
49	fullyParallel: true,
50	retries: process.env.CI ? 1 : 0,
51	reporter: [
52	['html'],
53	['json', { outputFile: 'test-results/api-results.json' }],
54	],
55	use: {
56	baseURL: process.env.API_BASE_URL \|\| 'http://localhost:3000/api',
57	extraHTTPHeaders: {
58	'Accept': 'application/json',
59	'Content-Type': 'application/json',
60	},
61	},
62	});
63	```
64
65	## Response Models
66
67	Define TypeScript interfaces for all API payloads:
68
69	```typescript
70	// models/user.model.ts
71	export interface User {
72	id: string;
73	email: string;
74	name: string;
75	role: 'admin' \| 'user' \| 'viewer';
76	createdAt: string;
77	updatedAt: string;
78	}
79
80	export interface CreateUserRequest {
81	email: string;
82	name: string;
83	password: string;
84	role?: 'admin' \| 'user' \| 'viewer';
85	}
86
87	export interface UpdateUserRequest {
88	name?: string;
89	role?: 'admin' \| 'user' \| 'viewer';
90	}
91
92	export interface UserListResponse {
93	data: User[];
94	total: number;
95	page: number;
96	pageSize: number;
97	}
98
99	export interface ApiError {
100	statusCode: number;
101	message: string;
102	error: string;
103	details?: Record<string, string[]>;
104	}
105	```
106
107	## Base API Client
108
109	```typescript
110	// clients/base-api-client.ts
111	import { APIRequestContext, APIResponse } from '@playwright/test';
112
113	export class BaseApiClient {
114	protected readonly request: APIRequestContext;
115	protected readonly basePath: string;
116
117	constructor(request: APIRequestContext, basePath: string) {
118	this.request = request;
119	this.basePath = basePath;
120	}
121
122	protected async get(path: string, params?: Record<string, string>): Promise<APIResponse> {
123	const url = params
124	? `${this.basePath}${path}?${new URLSearchParams(params)}`
125	: `${this.basePath}${path}`;
126	return this.request.get(url);
127	}
128
129	protected async post(path: string, data: unknown): Promise<APIResponse> {
130	return this.request.post(`${this.basePath}${path}`, { data });
131	}
132
133	protected async put(path: string, data: unknown): Promise<APIResponse> {
134	return this.request.put(`${this.basePath}${path}`, { data });
135	}
136
137	protected async patch(path: string, data: unknown): Promise<APIResponse> {
138	return this.request.patch(`${this.basePath}${path}`, { data });
139	}
140
141	protected async delete(path: string): Promise<APIResponse> {
142	return this.request.delete(`${this.basePath}${path}`);
143	}
144	}
145	```
146
147	### Domain-Specific API Client
148
149	```typescript
150	// clients/users-api-client.ts
151	import { APIRequestContext, APIResponse } from '@playwright/test';
152	import { BaseApiClient } from './base-api-client';
153	import { CreateUserRequest, UpdateUserRequest } from '../models/user.model';
154
155	export class UsersApiClient extends BaseApiClient {
156	constructor(request: APIRequestContext) {
157	super(request, '/users');
158	}
159
160	async list(page = 1, pageSize = 10): Promise<APIResponse> {
161	return this.get('', { page: String(page), pageSize: String(pageSize) });
162	}
163
164	async getById(id: string): Promise<APIResponse> {
165	return this.get(`/${id}`);
166	}
167
168	async create(user: CreateUserRequest): Promise<APIResponse> {
169	return this.post('', user);
170	}
171
172	async update(id: string, data: UpdateUserRequest): Promise<APIResponse> {
173	return this.patch(`/${id}`, data);
174	}
175
176	async remove(id: string): Promise<APIResponse> {
177	return this.delete(`/${id}`);
178	}
179
180	async search(query: string): Promise<APIResponse> {
181	return this.get('/search', { q: query

People who liked this also viewed

6 picks

Type

agent-browserBrowser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web aSkillsJul 2026571k39k
browser-act--- name: browser-act description: "Browser automation CLI for AI agents. NEVER run browser-act commands directly via Bash — always invoke this skill first. Use browser-act when a user mentions it bSkillsJul 2026107k4.6k
playwright-cliAutomate browser interactions, test web pages and work with Playwright tests.SkillsJul 202695k12k
accessibilityAudit and improve web accessibility following WCAG 2.2 guidelines. Use when asked to "improve accessibility", "a11y audit", "WCAG compliance", "screen reader support", "keyboard navigation", or "make SkillsJun 202638k2.5k
anti-detect-browserLaunch and manage anti-detect browsers with unique real-device fingerprints for multi-account operations, web scraping, ad verification, and AI agent automation. Use when the user needs to run multiplSkillsMar 202630k3
web-access所有联网操作必须通过此 skill 处理，包括：搜索、网页抓取、登录后操作、网络交互等。触发场景：用户要求搜索信息、查看网页内容、访问需要登录的网站、操作网页界面、抓取社交媒体内容（小红书、微博、推特等）、读取动态渲染页面、以及任何需要真实浏览器环境的网络任务。SkillsMay 202615k8.4k

playwright-api

2installs17forks

View on GitHub

How to install playwright-api?

pramoddutta/qaskills/playwright-api

$npx -y skills add PramodDutta/qaskills --skill playwright-api

Installs into the current project.

Summary

API testing skill using Playwright's built-in APIRequestContext for RESTful service validation, authentication flows, and API contract verification.

Files · 1

View on GitHub

SKILL.md

1	# Playwright API Testing Skill
2
3	You are an expert QA automation engineer specializing in API testing using Playwright's built-in `APIRequestContext`. When the user asks you to write, review, or debug API tests with Playwright, follow these detailed instructions.
4
5	## Core Principles
6
7	1. Playwright-native API testing -- Use `APIRequestContext` instead of external HTTP libraries.
8	2. Type safety -- Define interfaces for all request/response payloads.
9	3. Isolation -- Each test manages its own data lifecycle (create, verify, clean up).
10	4. Comprehensive validation -- Check status codes, headers, response body structure, and timing.
11	5. Reusable abstractions -- Build API client classes for each service domain.
12
13	## Project Structure
14
15	```
16	tests/
17	api/
18	auth/
19	auth-api.spec.ts
20	users/
21	users-api.spec.ts
22	users-crud.spec.ts
23	products/
24	products-api.spec.ts
25	fixtures/
26	api.fixture.ts
27	auth-api.fixture.ts
28	models/
29	user.model.ts
30	product.model.ts
31	api-response.model.ts
32	clients/
33	base-api-client.ts
34	users-api-client.ts
35	products-api-client.ts
36	utils/
37	api-helpers.ts
38	schema-validator.ts
39	playwright.config.ts
40	```
41
42	## Configuration
43
44	```typescript
45	import { defineConfig } from '@playwright/test';
46
47	export default defineConfig({
48	testDir: './tests/api',
49	fullyParallel: true,
50	retries: process.env.CI ? 1 : 0,
51	reporter: [
52	['html'],
53	['json', { outputFile: 'test-results/api-results.json' }],
54	],
55	use: {
56	baseURL: process.env.API_BASE_URL \|\| 'http://localhost:3000/api',
57	extraHTTPHeaders: {
58	'Accept': 'application/json',
59	'Content-Type': 'application/json',
60	},
61	},
62	});
63	```
64
65	## Response Models
66
67	Define TypeScript interfaces for all API payloads:
68
69	```typescript
70	// models/user.model.ts
71	export interface User {
72	id: string;
73	email: string;
74	name: string;
75	role: 'admin' \| 'user' \| 'viewer';
76	createdAt: string;
77	updatedAt: string;
78	}
79
80	export interface CreateUserRequest {
81	email: string;
82	name: string;
83	password: string;
84	role?: 'admin' \| 'user' \| 'viewer';
85	}
86
87	export interface UpdateUserRequest {
88	name?: string;
89	role?: 'admin' \| 'user' \| 'viewer';
90	}
91
92	export interface UserListResponse {
93	data: User[];
94	total: number;
95	page: number;
96	pageSize: number;
97	}
98
99	export interface ApiError {
100	statusCode: number;
101	message: string;
102	error: string;
103	details?: Record<string, string[]>;
104	}
105	```
106
107	## Base API Client
108
109	```typescript
110	// clients/base-api-client.ts
111	import { APIRequestContext, APIResponse } from '@playwright/test';
112
113	export class BaseApiClient {
114	protected readonly request: APIRequestContext;
115	protected readonly basePath: string;
116
117	constructor(request: APIRequestContext, basePath: string) {
118	this.request = request;
119	this.basePath = basePath;
120	}
121
122	protected async get(path: string, params?: Record<string, string>): Promise<APIResponse> {
123	const url = params
124	? `${this.basePath}${path}?${new URLSearchParams(params)}`
125	: `${this.basePath}${path}`;
126	return this.request.get(url);
127	}
128
129	protected async post(path: string, data: unknown): Promise<APIResponse> {
130	return this.request.post(`${this.basePath}${path}`, { data });
131	}
132
133	protected async put(path: string, data: unknown): Promise<APIResponse> {
134	return this.request.put(`${this.basePath}${path}`, { data });
135	}
136
137	protected async patch(path: string, data: unknown): Promise<APIResponse> {
138	return this.request.patch(`${this.basePath}${path}`, { data });
139	}
140
141	protected async delete(path: string): Promise<APIResponse> {
142	return this.request.delete(`${this.basePath}${path}`);
143	}
144	}
145	```
146
147	### Domain-Specific API Client
148
149	```typescript
150	// clients/users-api-client.ts
151	import { APIRequestContext, APIResponse } from '@playwright/test';
152	import { BaseApiClient } from './base-api-client';
153	import { CreateUserRequest, UpdateUserRequest } from '../models/user.model';
154
155	export class UsersApiClient extends BaseApiClient {
156	constructor(request: APIRequestContext) {
157	super(request, '/users');
158	}
159
160	async list(page = 1, pageSize = 10): Promise<APIResponse> {
161	return this.get('', { page: String(page), pageSize: String(pageSize) });
162	}
163
164	async getById(id: string): Promise<APIResponse> {
165	return this.get(`/${id}`);
166	}
167
168	async create(user: CreateUserRequest): Promise<APIResponse> {
169	return this.post('', user);
170	}
171
172	async update(id: string, data: UpdateUserRequest): Promise<APIResponse> {
173	return this.patch(`/${id}`, data);
174	}
175
176	async remove(id: string): Promise<APIResponse> {
177	return this.delete(`/${id}`);
178	}
179
180	async search(query: string): Promise<APIResponse> {
181	return this.get('/search', { q: query

People who liked this also viewed

6 picks

Type