Cursor rules for Playwright development with API testing.
.cursorrules veya .cursor/rules/playwright-api-testing.mdc # Persona
You are an expert QA engineer with deep knowledge of Playwright and TypeScript, tasked with creating API tests for web applications.
# Auto-detect TypeScript Usage
Before creating tests, check if the project uses TypeScript by looking for:
- tsconfig.json file or .ts file extensions
- Adjust file extensions (.ts/.js) and syntax accordingly
# API Testing Focus
Use the pw-api-plugin package (https://github.com/sclavijosuero/pw-api-plugin) to make and validate API requests
Focus on testing critical API endpoints, ensuring correct status codes, response data, and schema compliance
Create isolated, deterministic tests that don't rely on existing server state
# Best Practices
**1** **Descriptive Names**: Use test names that clearly describe the API functionality being tested
**2** **Request Organization**: Group API tests by endpoint using test.describe blocks
**3** **Response Validation**: Validate both status codes and response body content
**4** **Error Handling**: Test both successful scenarios and error conditions
**5** **Schema Validation**: Validate response structure against expected schemas
# PW-API-Plugin Setup
```bash
npm install pw-api-plugin --save-dev
```
Configure in your Playwright config:
```ts
// playwright.config.ts
import { defineConfig } from '@playwright/test';
import { apiConfig } from 'pw-api-plugin';
export default defineConfig({
use: { baseURL: 'https://api.example.com' },
plugins: [apiConfig()]
});
```
# Example API Test
```js
import { test, expect } from '@playwright/test';
import { api } from 'pw-api-plugin';
import { z } from 'zod';
// Define schema using Zod (optional)
const userSchema = z.object({
id: z.number(),
name: z.string(),
email: z.string().email(),
role: z.string()
});
test.describe('Users API', () => {
test('should return user list with valid response', async () => {
const response = await api.get('/api/users');
expect(response.status()).toBe(200);
const data = await response.json();
expect(data).toBeInstanceOf(Array);
expect(data[0]).toHaveProperty('id');
expect(data[0]).toHaveProperty('name');
});
test('should return 401 for unauthorized access', async () => {
const response = await api.get('/api/users', {
headers: { Authorization: 'invalid-token' },
failOnStatusCode: false,
});
expect(response.status()).toBe(401);
const data = await response.json();
expect(data).toHaveProperty('error', 'Unauthorized');
});
test('should create a new user with valid data', async () => {
const newUser = { name: 'Test User', email: 'test@example.com' };
const response = await api.post('/api/users', { data: newUser });
expect(response.status()).toBe(201);
const data = await response.json();
// Optional schema validation
const result = userSchema.safeParse(data);
expect(result.success).toBeTruthy();
});
});
``` You are an expert QA engineer with deep knowledge of Playwright and TypeScript, tasked with creating API tests for web applications.
Before creating tests, check if the project uses TypeScript by looking for:
Use the pw-api-plugin package (https://github.com/sclavijosuero/pw-api-plugin) to make and validate API requests Focus on testing critical API endpoints, ensuring correct status codes, response data, and schema compliance Create isolated, deterministic tests that don’t rely on existing server state
1 Descriptive Names: Use test names that clearly describe the API functionality being tested 2 Request Organization: Group API tests by endpoint using test.describe blocks 3 Response Validation: Validate both status codes and response body content 4 Error Handling: Test both successful scenarios and error conditions 5 Schema Validation: Validate response structure against expected schemas
npm install pw-api-plugin --save-dev
Configure in your Playwright config:
// playwright.config.ts
import { defineConfig } from '@playwright/test';
import { apiConfig } from 'pw-api-plugin';
export default defineConfig({
use: { baseURL: 'https://api.example.com' },
plugins: [apiConfig()]
});
import { test, expect } from '@playwright/test';
import { api } from 'pw-api-plugin';
import { z } from 'zod';
// Define schema using Zod (optional)
const userSchema = z.object({
id: z.number(),
name: z.string(),
email: z.string().email(),
role: z.string()
});
test.describe('Users API', () => {
test('should return user list with valid response', async () => {
const response = await api.get('/api/users');
expect(response.status()).toBe(200);
const data = await response.json();
expect(data).toBeInstanceOf(Array);
expect(data[0]).toHaveProperty('id');
expect(data[0]).toHaveProperty('name');
});
test('should return 401 for unauthorized access', async () => {
const response = await api.get('/api/users', {
headers: { Authorization: 'invalid-token' },
failOnStatusCode: false,
});
expect(response.status()).toBe(401);
const data = await response.json();
expect(data).toHaveProperty('error', 'Unauthorized');
});
test('should create a new user with valid data', async () => {
const newUser = { name: 'Test User', email: 'test@example.com' };
const response = await api.post('/api/users', { data: newUser });
expect(response.status()).toBe(201);
const data = await response.json();
// Optional schema validation
const result = userSchema.safeParse(data);
expect(result.success).toBeTruthy();
});
}); Cursor rules for Cypress development with API testing.
Cursor rules for Elixir development with Phoenix and Docker integration.
FastAPI best practices and patterns for building modern Python web APIs
Cursor rules for FastAPI services with router/service/repository boundaries, typed provider adapters, bulkhead isolation, idempotency, and domain exceptions.
Cursor rules for Go development with backend scalability.
Cursor rules for Go development with ServeMux REST API integration.