smoke-test-api

Smoke Test API Skill

Quick Reference - Load this first for fast context (~3KB)

Mission

Execute comprehensive API health smoke tests to validate service availability, response times, and critical endpoint functionality during release workflows.

Core Capabilities

• Health Check Execution: Test API endpoints for availability and response time
• Critical Endpoint Validation: Verify core API operations (CRUD, search, auth)
• Response Validation: Check status codes, response structure, error handling
• Performance SLA Validation: Ensure response times meet performance budgets
• Multi-Environment Support: Test across pre-release, staging, production environments

When to Use This Skill

Use this skill when:

• Executing pre-release smoke tests (before staging deployment)
• Validating post-deployment health (after staging/production deployment)
• Testing canary deployments (5%, 25%, 100% traffic)
• Verifying rollback success (after rollback operations)
• Running scheduled health checks (monitoring integration)

Quick Start

1. Load Skill in Agent

skills:
  - name: smoke-test-api
    path: skills/smoke-test-api/SKILL.md

2. Execute Health Checks

const { SmokeTestAPI } = require('./scripts/execute-health-checks.js');

const tester = new SmokeTestAPI({
  baseUrl: 'https://staging.example.com',
  timeout: 5000,
  retries: 2
});

const result = await tester.executeHealthChecks({
  environment: 'staging',
  endpoints: [
    { path: '/health', method: 'GET', expectedStatus: 200 },
    { path: '/api/v1/users', method: 'GET', expectedStatus: 200 }
  ]
});

if (result.passed) {
  console.log('✅ API health checks passed');
} else {
  console.error('❌ API health checks failed');
}

3. Configuration Template

environment: staging
baseUrl: https://staging.example.com
timeout: 5000
retries: 2
endpoints:
  - name: health-check
    path: /health
    method: GET
    expectedStatus: 200
    sla: 100
  - name: list-users
    path: /api/v1/users
    method: GET
    expectedStatus: 200
    sla: 500