OrdinoAPI - API Testing Framework

A powerful and flexible API testing framework built with Playwright, designed for easy API testing and automation.

Features

• HTTP Methods Support (GET, POST, PUT, DELETE, PATCH)
• Header Management
• Global Headers
• Header Presets
• Query Parameter Support
• Value Storage
• Timeout Configuration
• Clean and Simple API

Installation

npm install @playwright/test

Usage

Basic Example

import { OrdinoAPI } from './src/OrdinoAPI';

// Initialize
await OrdinoAPI.init();

// Configure base URL
OrdinoAPI.setBaseUrl('https://api.example.com');

// Make requests
OrdinoAPI.setUrl('users');
const response = await OrdinoAPI.requestGet();
const users = await response.json();

// Cleanup
await OrdinoAPI.dispose();

Header Management

// Set single header
OrdinoAPI.setHeader('Authorization', 'Bearer token123');

// Set multiple headers
OrdinoAPI.setHeaders({
  'X-Custom': 'value',
  'X-Version': '1.0'
});

// Set global headers (applied to all requests)
OrdinoAPI.setGlobalHeader('Global-Header', 'value');

// Use header presets
OrdinoAPI.saveHeaderPreset('auth', {
  'Authorization': 'Bearer token123'
});
OrdinoAPI.loadHeaderPreset('auth');

Making Requests

// POST request
const newUser = { name: 'John Doe' };
const response = await OrdinoAPI.requestPost(newUser);

// GET request with query parameters
const response = await OrdinoAPI.requestGetWithQuery({ status: 'active' });

// PUT request
const updatedUser = { id: 1, name: 'Jane Doe' };
const response = await OrdinoAPI.requestPut(updatedUser);

// DELETE request
const response = await OrdinoAPI.requestDelete();

Value Storage

// Store values
OrdinoAPI.setValue('userId', 123);

// Retrieve values
const userId = OrdinoAPI.getValue('userId');

// Clear values
OrdinoAPI.clearValue('userId');

Testing

The framework includes comprehensive tests covering all features. Run tests using:

npx playwright test tests/ordinoapi.spec.ts

Test coverage includes:

• Core Features
  • URL Configuration
  • Header Management
  • Value Storage
  • Timeout Configuration
• HTTP Methods
  • POST
  • GET
  • PUT
  • DELETE
  • PATCH
  • Query Parameters

Best Practices

1. Always initialize OrdinoAPI before use:

await OrdinoAPI.init();

2. Clean up resources after use:

await OrdinoAPI.dispose();

3. Use header presets for reusable header configurations:

OrdinoAPI.saveHeaderPreset('auth', authHeaders);
// Later...
OrdinoAPI.loadHeaderPreset('auth');

4. Set appropriate timeouts for long-running requests:

OrdinoAPI.setTimeout(30000); // 30 seconds

License

MIT