Skip to main content

A comprehensive testing framework for REST APIs with functional and performance testing capabilities

Project description

RapidTest Logo

RapidTest

A lightweight library for REST API testing with functional checks, ASGI direct mode, fake data generation, and basic performance testing.

Features

  • Simple HTTP testing with GET, POST, PUT, PATCH, DELETE
  • Built-in response validation (status, JSON body, required keys)
  • ASGI direct mode for testing app instances without running an HTTP server
  • Fake data generation with Faker
  • Basic load testing with concurrent users (threading + requests)
  • Test any endpoint with just one line of code

Installation

pip install rapidtest

CLI

Generate a test skeleton file:

rapidtest init

Quick Start (HTTP mode)

from rapidtest import Test, StatusCode

api = Test(url="http://localhost:8000")

# GET with status + key validation
api.get(
    path="/health",
    status=StatusCode.OK_200,
    keys=["message"]
)

# POST with request body + expected response body
payload = {"username": "hector", "password": "secret"}
api.post(
    path="/login",
    json=payload,
    status=StatusCode.OK_200,
    keys=["token"]
)

Quick Start (ASGI mode)

Use this when you want to test your ASGI app directly (for example FastAPI) without network overhead.

from fastapi import FastAPI
from rapidtest import Test, StatusCode

app = FastAPI()

@app.get("/ping")
def ping():
    return {"ok": True}

tester = Test(app=app, asgi_mode=True)

tester.get(
    path="/ping",
    status=StatusCode.OK_200,
    json={"ok": True}
)

Data Generation

from rapidtest import data

auth = data.generate_auth_user()

print(auth)  # {"username": "...", "password": "..."}

Useful helpers include:

  • generate_name()
  • generate_email()
  • generate_phone()
  • more..

Performance Testing

from rapidtest import Performance

perf = Performance(
    base_url="http://localhost:8000",
    users=20,
    duration=15,
    timeout=10
)

perf.add_get_task(endpoint="/health")
results = perf.run()

Returned metrics:

  • total_requests
  • successful_requests
  • failed_requests
  • success_rate
  • avg_response_time
  • min_response_time
  • max_response_time
  • requests_per_second
  • duration
  • users

Requirements

  • Python >=3.7
  • requests>=2.25.1
  • faker>=13.0.0

Project Info

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rapidtest-0.5.1.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rapidtest-0.5.1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file rapidtest-0.5.1.tar.gz.

File metadata

  • Download URL: rapidtest-0.5.1.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for rapidtest-0.5.1.tar.gz
Algorithm Hash digest
SHA256 84ed08a588e21d427bfed9efdd0c26401602f6dca07a547855473a7ae953bebd
MD5 375a5d6caca438c5fa6481d8d5beb696
BLAKE2b-256 73f8acbc89d19caf78131bb332bbe27c4b50f033aca6b1f5eb42d58dc2fb3de1

See more details on using hashes here.

File details

Details for the file rapidtest-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: rapidtest-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for rapidtest-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c89221151f7a17fc44ea654d6babe3b2a0827b1e1098c71c760be9f9bac3711c
MD5 1564fcfa36530cd10bf3a81cfe5ef62d
BLAKE2b-256 55e8864a8db8ece4d4ce07348d0eed5baadc97398dfd4b68fdf8e5b24295dee0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page