Skip to main content

Benchmarking tool to compare REST and GraphQL API performance

Project description

apibeat

A simple CLI tool to benchmark and compare REST vs GraphQL API performance by measuring average latency.

Features

  • Measure average latency of REST and GraphQL endpoints
  • Support custom HTTP methods (GET, POST, etc.) for REST
  • Accept GraphQL queries via CLI
  • Simple, clean CLI interface
  • Useful for API optimization and performance comparisons

Installation

Install from PyPI

pip install apibeat

Benchmark REST API with default GET method

 apibeat --url https://api.example.com/data

Use a different HTTP method (REST)

apibeat --url https://api.example.com/data --method POST

Use a different HTTP method (GraphQL Apis)

apibeat --type graphql --url https://api.example.com/graphql --query "{ users { id name } }"

CLI Arguments

Argument Description Required Default
--url The API endpoint URL to benchmark Yes NA
--type API type: rest or graphql No rest
--method HTTP method for REST requests No (only for REST) GET
--query GraphQL query string (required if --type graphql) Conditional NA

For any questions or support, please open an issue or contact demonking15543@gmail.com.

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

apibeat-0.1.8.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

apibeat-0.1.8-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file apibeat-0.1.8.tar.gz.

File metadata

  • Download URL: apibeat-0.1.8.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for apibeat-0.1.8.tar.gz
Algorithm Hash digest
SHA256 02e7de59e12944d6364e65018263d226a6f16afc3612cc3e65ab55a9ac8ea981
MD5 d29a0ba9102e62ffe460f13dd7c3f504
BLAKE2b-256 b71475c16f1e9dfb1c627357eb8a22016a21555ce7f28912bc0e17315b855bce

See more details on using hashes here.

File details

Details for the file apibeat-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: apibeat-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for apibeat-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a93ed84ca69bff0b6bfddba010f1245952d6bf5d7cc8c0c6f84a63404fb61487
MD5 09f1f70ca86a721cb96562b89ddfe62a
BLAKE2b-256 ee2f8e2a6f4607d37fb1b2bcbdbe79b008170a8e85267ea74530bd1296faa501

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