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



### Use a different HTTP method (REST)

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


### Use a different HTTP method (GraphQL Apis)


```bash
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                 | —       |
| `--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         | —       |


For any questions or support, please open an issue or contact [demonking15543@gmail.com](mailto: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.4.tar.gz (3.8 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.4-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apibeat-0.1.4.tar.gz
  • Upload date:
  • Size: 3.8 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.4.tar.gz
Algorithm Hash digest
SHA256 8bacd9ff0993670f9df33ab1aff64c8bfd91aa67116d1ba44416efcb82721ed2
MD5 589e870c67e763f4847260de2b680b3b
BLAKE2b-256 34c2571707167e10b8dd2673046204397515747861c59dd17f42c38ab7b2bf61

See more details on using hashes here.

File details

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

File metadata

  • Download URL: apibeat-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7f74cf23488d36fe617ae69b5fe8f214d3e078b911c6b414727b51cb29fa3d6a
MD5 06b223f9e5e40a6cf9e04cde4cd855d7
BLAKE2b-256 8f044b4afbcdebe94a3adff4bbb153620a802adbc0a986a19f5c23219f68f87b

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