🚀 API Load Test

A professional, production-ready k6 load testing framework for testing any REST API. Built with best practices, comprehensive test scenarios, and clear performance metrics.

🌐 Web Interface

Test any API with a beautiful web interface at loadtest.mahiiyh.me

The web app provides:

🎨 User-friendly interface for configuring API tests without CLI
📊 Real-time visualization of test results with interactive charts
📈 Performance metrics - response times, throughput, status codes
🧪 Multiple test scenarios - Smoke, Load, Stress, Spike, Soak tests
🔧 Full HTTP support - All methods, custom headers, request bodies
🚀 No installation required - Test APIs directly from your browser

Try the demo mode to see how it works, or connect a backend to run actual k6 tests.

See web/ for local development or WEB_DEPLOYMENT.md for deployment instructions.

✨ Features

🎯 Multiple Test Scenarios: Smoke, Load, Stress, Spike, and Soak tests
🔐 Authentication Support: JWT token-based authentication
📊 Detailed Metrics: Request duration, failure rates, and custom thresholds
🔧 Easy Configuration: Environment-based config for dev/staging/production
📦 Sample Data: Ready-to-use sample datasets (10, 50, 100 records)
📈 Performance Reports: Built-in threshold validation and suggestions
🎨 Clean Code: Modular structure with reusable utilities

🎯 Framework vs Examples

This repository contains TWO key components:

1. Generic Framework (Reusable for Any API)

The core framework is fully generic and can test any REST API:

config/ - Environment and threshold configuration
utils/ - Authentication, validation, and helper functions
templates/ - Clean templates to copy and customize
tests/ - Generic test structure for all scenarios

2. Working Example (Attendance Bulk Upload API)

A complete real-world implementation showing the framework in action:

examples/attendance-api/ - Full implementation testing an attendance API
Demonstrates authentication, data transformation, and bulk operations
Includes real performance analysis and optimization recommendations

You can use this framework for ANY API by:

Copying templates from templates/
Updating config/env.js with your API details
Customizing test files for your endpoints
Running tests just like the attendance example

See the Templates Guide and Getting Started for step-by-step instructions.

🔧 Prerequisites

k6 - Load testing tool
Node.js (v16+) - For running scripts (optional)

Install k6

# macOS
brew install k6

# Windows
choco install k6

# Linux
sudo gpg -k
sudo gpg --no-default-keyring --keyring /usr/share/keyrings/k6-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys C5AD17C747E3415A3642D57D77C6C491D6AC1D69
echo "deb [signed-by=/usr/share/keyrings/k6-archive-keyring.gpg] https://dl.k6.io/deb stable main" | sudo tee /etc/apt/sources.list.d/k6.list
sudo apt-get update
sudo apt-get install k6

# Docker
docker pull grafana/k6

📦 Installation

# Clone the repository
git clone https://github.com/mahiiyh/api-load-test.git
cd api-load-test

# (Optional) Install npm dependencies for scripts
npm install

🚀 Quick Start

Option 1: Use Generic Tests (5 minutes)

Configure your API - Edit config/env.js:

export const environments = {
  dev: {
    baseURL: 'http://localhost:5000',  // Your API URL
    testUsers: {
      admin: {
        username: 'admin',
        password: 'yourpassword'
      }
    }
  }
};

Run a generic test:

k6 run -e ENVIRONMENT=dev tests/smoke/api-smoke.js

Option 2: Create Custom Tests from Templates (15 minutes)

Copy a template:

cp templates/smoke.template.js tests/smoke/my-api-smoke.js

Update the template with your endpoints:
- Find all ← UPDATE: comments
- Replace with your API URLs and payloads

Run your custom test:

k6 run -e ENVIRONMENT=dev tests/smoke/my-api-smoke.js

See templates/README.md for detailed customization guide.

Option 3: Learn from Working Example (30 minutes)

Explore the complete attendance API example:

# Study the example structure
cd examples/attendance-api/

# Run the example tests
k6 run -e ENVIRONMENT=dev tests/attendance-bulk-upload-smoke.js

See examples/attendance-api/README.md for walkthrough.

After Running Tests

You'll see comprehensive results:

✅ Pass/Fail Metrics - Which thresholds passed
📊 Performance Stats - Response times, throughput
🎯 Recommendations - What to optimize

⚙️ Configuration

Environment Setup

Configure different environments in config/env.js:

export const environments = {
  dev: {
    baseURL: 'http://localhost:5000',
    testUsers: { /* ... */ }
  },
  staging: {
    baseURL: 'https://staging-api.example.com',
    testUsers: { /* ... */ }
  },
  production: {
    baseURL: 'https://api.example.com',
    testUsers: { /* ... */ }
  }
};

Performance Thresholds

Customize thresholds in config/thresholds.js:

export const thresholds = {
  http_req_duration: ['p(95)<2000'],  // 95% of requests under 2s
  http_req_failed: ['rate<0.05'],     // Less than 5% failures
  // Add custom thresholds...
};

🧪 Running Tests

Command Line

# Specify environment with -e flag
k6 run -e ENVIRONMENT=dev tests/smoke/api-smoke.js
k6 run -e ENVIRONMENT=staging tests/load/api-load.js

NPM Scripts

npm run test:smoke          # Quick smoke test
npm run test:load           # Standard load test
npm run test:stress         # Stress test (find limits)
npm run test:spike          # Spike test (sudden traffic)
npm run test:soak           # Soak test (long duration)

Bulk Upload Tests (Example Use Case)

Test bulk upload endpoints with different payload sizes:

# Test with sample data (10, 50, 100 records)
npm run test:attendance-smoke
npm run test:attendance-load
npm run test:attendance-stress

📊 Test Scenarios

1. Smoke Test 🔥

Purpose: Quick validation that API is functional
Duration: ~1 minute
VUs: 1
Use Case: Pre-deployment checks, CI/CD pipelines

k6 run -e ENVIRONMENT=dev tests/smoke/api-smoke.js

2. Load Test 📈

Purpose: Test under expected normal load
Duration: 5-10 minutes
VUs: 2-10 (ramping)
Use Case: Validate performance under typical usage

k6 run -e ENVIRONMENT=dev tests/load/api-load.js

3. Stress Test 💪

Purpose: Find breaking points
Duration: 10-20 minutes
VUs: 5-50 (gradual increase)
Use Case: Capacity planning, failure mode analysis

k6 run -e ENVIRONMENT=dev tests/stress/api-stress.js

4. Spike Test ⚡

Purpose: Handle sudden traffic bursts
Duration: 5 minutes
VUs: 1 → 100 → 1 (sudden spike)
Use Case: Marketing campaigns, viral traffic

k6 run -e ENVIRONMENT=dev tests/spike/api-spike.js

5. Soak Test ⏳

Purpose: Long-term stability (memory leaks, degradation)
Duration: 1-4 hours
VUs: 5-10 (constant)
Use Case: Production stability validation

k6 run -e ENVIRONMENT=dev tests/soak/api-soak.js

📈 Understanding Results

Example Output

✓ http_req_duration......: avg=1.2s  p(95)=1.8s  p(99)=2.1s
✓ http_req_failed........: 0.00%    (0 out of 1000)
✓ http_reqs..............: 1000     16.67/s
✓ iterations.............: 500      8.33/s

Key Metrics Explained

Metric	What It Means	Good Target
http_req_duration	How long requests take	p95 < 2s
http_req_failed	% of failed requests	< 1%
http_reqs	Total requests made	-
iterations	Test iterations completed	-
vus	Virtual users (concurrent)	-

Threshold Results

✅ Green (Passed): Performance is acceptable
❌ Red (Failed): Performance issue detected

🔍 Performance Optimization

Common Issues & Solutions

❌ Problem: High Response Times (p95 > 5s)

Symptoms:

✗ http_req_duration: p(95)=11.66s (threshold: p(95)<5000)

Root Causes:

Database queries - Unoptimized queries, missing indexes
Bulk operations - Processing too many records at once
External API calls - Third-party services slowing down
Memory/CPU limits - Server resources exhausted

Solutions:

Add database indexes on frequently queried fields
Implement batch processing with queues
Add caching (Redis, Memcached)
Optimize queries (use EXPLAIN, avoid N+1)
Scale horizontally (add more servers)
Use async processing for heavy tasks

❌ Problem: Request Failures (> 1%)

Symptoms:

✗ http_req_failed: rate=5.2% (threshold: rate<0.01)

Root Causes:

Server errors (500s) - Application crashes
Timeouts - Requests taking too long
Rate limiting - Too many requests blocked
Authentication issues - Token expiration

Solutions:

Check server logs for error details
Add error handling and retries
Implement rate limiting on client side
Refresh tokens before expiration
Add health checks and monitoring

❌ Problem: Inconsistent Performance

Symptoms:

Response times vary wildly: avg=2s, max=45s

Root Causes:

Resource contention - Other processes competing
Garbage collection - Long GC pauses
Cold starts - Serverless/container spin-up
Network issues - Unstable connection

Solutions:

Use dedicated test environment
Tune JVM/runtime GC settings
Pre-warm serverless functions
Test from consistent network location

Performance Benchmarks

Record Size	Target p95	Target p99	Acceptable Failure Rate
1-10 records	< 1s	< 2s	< 0.1%
50 records	< 3s	< 5s	< 0.5%
100 records	< 5s	< 10s	< 1%

📁 Project Structure

api-load-test/
├── 📂 config/                    # ⚙️  FRAMEWORK: Configuration
│   ├── env.js                    #    Environment configs (dev/staging/prod)
│   └── thresholds.js             #    Performance thresholds
│
├── 📂 utils/                     # 🔧 FRAMEWORK: Utilities
│   ├── auth.js                   #    Authentication helpers
│   └── helpers.js                #    Common utilities
│
├── 📂 templates/                 # 📋 FRAMEWORK: Test Templates
│   ├── README.md                 #    How to use templates
│   ├── smoke.template.js         #    Smoke test template
│   ├── load.template.js          #    Load test template
│   └── stress.template.js        #    Stress test template
│
├── 📂 tests/                     # 🧪 FRAMEWORK: Generic Tests
│   ├── smoke/                    #    Quick validation tests
│   │   ├── api-smoke.js          #    Generic API smoke test
│   │   └── lankem-erp-smoke.js   #    Custom API smoke test
│   ├── load/                     #    Standard load tests
│   │   ├── api-load.js           #    Generic load test
│   │   └── lankem-erp-load.js    #    Custom load test
│   ├── stress/                   #    Stress/capacity tests
│   │   └── api-stress.js         #    Generic stress test
│   ├── spike/                    #    Spike tests
│   │   └── api-spike.js          #    Generic spike test
│   ├── soak/                     #    Long-duration tests
│   │   └── api-soak.js           #    Generic soak test
│   └── validation/               #    Business logic validation
│       └── business-rules-validation.js
│
├── 📂 examples/                  # 📚 EXAMPLES: Working Implementations
│   └── attendance-api/           #    Complete attendance API example
│       ├── README.md             #    Example documentation
│       ├── tests/                #    Example test files
│       │   ├── attendance-bulk-upload-smoke.js
│       │   ├── attendance-bulk-upload-load.js
│       │   └── attendance-bulk-upload-stress.js
│       ├── utils/                #    Example helpers
│       │   └── attendance-helpers.js
│       └── sample-data/          #    Example test data
│           ├── attendance-sample-10.json
│           ├── attendance-sample-50.json
│           ├── attendance-sample-100.json
│           └── README.md
│
├── 📂 scripts/                   # 🛠️  TOOLS: Utilities
│   └── generate-sample-data.js   #    Data generation helper
│
├── 📂 reports/                   # 📊 OUTPUT: Test results (gitignored)
│
├── 📄 .gitignore
├── 📄 .env.example               #    Environment template
├── 📄 package.json               #    NPM scripts and metadata
├── 📄 LICENSE                    #    MIT License
├── 📄 README.md                  #    This file
├── 📄 GETTING_STARTED.md         #    Quick start guide
├── 📄 RESULTS_ANALYSIS.md        #    Performance analysis (example)
├── 📄 CONTRIBUTING.md            #    Contribution guidelines
├── 📄 CHANGELOG.md               #    Version history
└── 📄 CONTRIBUTORS.md            #    Team recognition

Legend:

⚙️ FRAMEWORK: Core reusable components for any API
📋 TEMPLATES: Copy these to create your own tests
📚 EXAMPLES: Real-world reference implementations
🛠️ TOOLS: Helper scripts and utilities

🎯 Working Example: Attendance Bulk Upload API

The repository includes a complete, production-tested example demonstrating the framework with a real bulk upload API:

What's Included

Full test suite: Smoke, Load, and Stress tests
Real test data: JSON files with 10, 50, and 100 records
Custom helpers: Domain-specific data transformation
Performance analysis: Real results with optimization recommendations

Location

examples/attendance-api/
├── README.md                           # Example overview
├── tests/                              # Test implementations
├── utils/attendance-helpers.js         # Custom helpers
└── sample-data/                        # Test datasets

Key Learnings from This Example

Authentication patterns - JWT tokens in non-standard response paths
Dynamic data - Updating timestamps before upload
Performance issues - 100 records taking 11.66s (documented with fixes)
Multiple payload sizes - Testing with different data volumes
Real optimization - 8 specific recommendations in RESULTS_ANALYSIS.md

How to Run the Example

# Quick smoke test (validates all payload sizes)
k6 run -e ENVIRONMENT=dev examples/attendance-api/tests/attendance-bulk-upload-smoke.js

# Full load test (performance baseline)
k6 run -e ENVIRONMENT=dev examples/attendance-api/tests/attendance-bulk-upload-load.js

# Stress test (find breaking point)
k6 run -e ENVIRONMENT=dev examples/attendance-api/tests/attendance-bulk-upload-stress.js

Adapting for Your API

Copy the structure: cp -r examples/attendance-api examples/my-api
Update sample data: Replace JSON files with your payload structure
Modify helpers: Update transformation logic for your data
Adjust thresholds: Set performance expectations for your API
Run tests: Same commands, different endpoints

See examples/attendance-api/README.md for detailed walkthrough.

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Built with k6 by Grafana Labs
Inspired by load testing best practices from the k6 community

📞 Support

👥 Contributors

@mahiiyh - Mahima Sandaken (Creator & Maintainer)
@Vishwa0527 - Contributor
@kavishkadinajara - Contributor

Made with ❤️ for performance-focused developers

Name		Name	Last commit message	Last commit date
Latest commit History 13 Commits
.github		.github
config		config
examples/attendance-api		examples/attendance-api
reports		reports
scripts		scripts
templates		templates
tests		tests
utils		utils
web		web
.env.example		.env.example
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS.md		CONTRIBUTORS.md
GETTING_STARTED.md		GETTING_STARTED.md
LICENSE		LICENSE
README.md		README.md
package.json		package.json

License

mahiiyh/api-load-test

Folders and files

Latest commit

History

Repository files navigation

🚀 API Load Test

🌐 Web Interface

✨ Features

🎯 Framework vs Examples

1. Generic Framework (Reusable for Any API)

2. Working Example (Attendance Bulk Upload API)

📋 Table of Contents

🔧 Prerequisites

Install k6

📦 Installation

🚀 Quick Start

Option 1: Use Generic Tests (5 minutes)

Option 2: Create Custom Tests from Templates (15 minutes)

Option 3: Learn from Working Example (30 minutes)

After Running Tests

⚙️ Configuration

Environment Setup

Performance Thresholds

🧪 Running Tests

Command Line

NPM Scripts

Bulk Upload Tests (Example Use Case)

📊 Test Scenarios

1. Smoke Test 🔥

2. Load Test 📈

3. Stress Test 💪

4. Spike Test ⚡

5. Soak Test ⏳

📈 Understanding Results

Example Output

Key Metrics Explained

Threshold Results

🔍 Performance Optimization

Common Issues & Solutions

❌ Problem: High Response Times (p95 > 5s)

❌ Problem: Request Failures (> 1%)

❌ Problem: Inconsistent Performance

Performance Benchmarks

📁 Project Structure

🎯 Working Example: Attendance Bulk Upload API

What's Included

Location

Key Learnings from This Example

How to Run the Example

Adapting for Your API

🤝 Contributing

📄 License

🙏 Acknowledgments

📞 Support

👥 Contributors

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages