Clobbr - test your api's response times

Test your api endpoints to see how well they perform under multiple requests (clobber your apis!), in sequence or parallel.

| <img width="620px" src="https://user-images.githubusercontent.com/1515742/198825002-b4633117-d6a0-4025-821d-fb6605c209a2.gif" alt="Clobbr api endpoint performance and speed test Application demo" /> | <img width="600px" src="https://user-images.githubusercontent.com/1515742/113618284-be106a00-9657-11eb-9709-04b911e7ccd5.gif" alt="Clobbr api endpoint performance and speed test demo" /> | |-|-|

Quick start

Application

Download on the Mac App Store or the Microsoft Store and start testing your api endpoints.

Command Line (cli)

npx @clobbr/cli run --url "https://api.github.com/zen"

Run npx @clobbr/cli to see all options or head over to @clobbr/cli docs.

Binaries are also available for your favorite OS here ⬇️ 💿.

CI/CD

The cli can be used in a CI context too. See examples with popular CIs here ↗️

What the cli can do

This package can stress-test your API endpoints in various ways so you can get a better idea on how your app would work under a (closer to) real world scenario.

Configure requests, set iterations and analyze response times of your API endpoints in a fashionable ascii chart or jaw-dropping table.

On top of that, get stats on responses such as mean, standard deviation, 5th/95th/99th percentiles and more.

With all that, output to various file formats such as csv, json, yaml and more. Use in your CI of choice or just run it locally.

Usage examples for the cli

Kitchen sink example

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --method GET \
  --iterations 50 \
  --parallel \
  --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95 \
  --headersPath "headers.json" \
  --dataPath "data.json" \
  --outputFile \
  --outputFormat yaml \
  --table "compact"

This is an advanced run configuration example. Typically, less config is needed. Read on for more.

Define iterations

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 30

Send requests in parallel

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 30 \
  --parallel

Display a summary table

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 30 \
  --table "full"

Display a minimal summary table

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 30 \
  --table "compact"

Customize Request Method

GET is used as the default request method, but you can pass an optional request method, such as POST, PUT, PATCH, DELETE etc.

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --method OPTIONS

Send Headers

Arbitrary request headers are accepted as a JSON file.

Tip 💡

Passing { Cookie: "val" } adds a cookie to the request.

# headers.json
{
  "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Et9HFtf9R3",
  "User-Agent": "Mozilla/5.0"
}

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 20 \
  --headersPath "headers.json"

Send Data

Arbitrary request data is accepted as a JSON file.

# data.json
{
  "id": "17b",
  "user": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "visits": 50
}

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 20 \
  --method "POST" \
  --dataPath "data.json"

Analyze failed request iterations

By default, details on failed iterations are neatly displayed via the table option.

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --iterations 20 \
  --method "POST" \
  --headersPath "headers.json" \
  --dataPath "data.json" \
  --table "compact"

Get results in different file formats

Results will be shown in a human-readable format by default, but you can also get results in JSON, YAML and CSV format.

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --outputFormat json                \
  --outputFile

Run checks against results

Set target values for percentage of success (pctOfSuccess), mean (ms), median (ms), standardDeviation (stdDev in ms) and supported quantiles in ms (q5, q50, q95, q99).

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95

Only include checks that you want to run. If you don't specify a check, it will not be run.

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --checks pctOfSuccess=90

Save 100s of hours of work by using Page AI to generate a beautiful website. In just minutes!

| | | | :- | :- | | <a href="https://pageai.pro" target="_blank"><img height="60px" src="https://pageai.pro/static/images/logo-square.png" alt="Page AI Logo" /></a> Page AI AI Website Generator that designs and writes clean code. Try the app on <a href="https://pageai.pro">pageai.pro</a>. | <a href="https://pageai.pro" target="_blank"><img width="300px" src="https://user-images.githubusercontent.com/1515742/281077548-57b24773-3c2a-4e89-b088-cc3945d7037b.png" alt="Page AI Logo" /></a> |

Apihustle is a collection of tools to test, improve and get to know your API inside and out. apihustle.com

| | | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------- | :------------------------------------------------------- | :------------------------------------------- | | <a href="https://pageai.pro" target="_blank"><img width="54px" src="https://github.com/user-attachments/assets/9bfbfe6f-add9-45de-aaf2-5c6043a47e41" alt="Page AI Logo" /></a> | Page AI | AI Website Generator that designs and writes clean code. | pageai.pro | | <a href="https://shipixen.com" target="_blank"><img width="54px" src="https://github.com/user-attachments/assets/e1deba72-328e-4d3c-9c62-11ab77184561" alt="Shipixen Logo" /

Clobbr

Install / Use

README