user@localhost:~$
reqbeam --help
ReqBeam - API Testing Tool v1.0.0
A CLI for testing and benchmarking API endpoints with detailed metrics.
Usage: reqbeam [command] [flags]
Commands:
help Help about any command
install Install the reqbeam CLI
test Test API endpoints with various configurations
benchmark Benchmark API endpoints with load testing
version Print version information
Flags:
-c, --config string Config file (default is $HOME/.reqbeam.yaml)
-h, --help Help for reqbeam
-v, --verbose Print verbose logs
Use reqbeam [command] --help for more information about a command.
Quick Start
user@localhost:~$
reqbeam install
user@localhost:~$
reqbeam test https://api.example.com/users --method GET --headers "Authorization: Bearer token"
Request: GET https://api.example.com/users
Status: 200 OK
Time: 247ms
Bytes: 1.2KB
Response:
{
"users": [
{"id": 1, "name": "John Doe"},
{"id": 2, "name": "Jane Smith"}
]
}
Advanced Benchmarking
user@localhost:~$
reqbeam benchmark https://api.example.com/users --concurrent 10 --requests 100 --method GET
Benchmarking GET https://api.example.com/users
Requests: 100
Concurrent: 10
Duration: 3.28s
Metrics:
- Avg Response Time: 327ms
- Slowest: 892ms
- Fastest: 89ms
- Requests/sec: 30.5
- 90% < 523ms
- Errors: 0
Response Codes: 100×200
user@localhost:~$
reqbeam benchmark https://api.example.com/users --concurrent 50 --requests 500
Benchmarking GET https://api.example.com/users
Requests: 500
Concurrent: 50
Duration: 18.45s
Metrics:
- Avg Response Time: 1.84s
- Slowest: 8.92s
- Fastest: 231ms
- Requests/sec: 27.1
- 90% < 3.21s
- Errors: 0
Response Codes: 500×200
Configuration File
base_url: "https://api.example.com"
headers:
"Authorization": "Bearer your-token"
"Content-Type": "application/json"
timeout: 30
concurrent: 10
user@localhost:~$
reqbeam test /users --config .reqbeam.yaml
Web Interface
user@localhost:~$
reqbeam server
Starting web server on http://localhost:8080
You can now access the web interface at:
http://localhost:8080