# Rust API client for limit-lens
A simple API for testing and visualizing rate limiters in real-time. Monitor request throughput and see how your rate limiting algorithms perform under load.
For more information, please visit []()
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 0.3.7
- Package version: 0.3.7
- Generator version: 7.13.0-SNAPSHOT
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `limit-lens` and add the following to `Cargo.toml` under `[dependencies]`:
```
limit-lens = { path = "./limit-lens" }
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:6969*
*HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /health | Health Check
*RateTestApi* | [**create_test_session**](docs/RateTestApi.md#create_test_session) | **POST** /api/test/session | Create a new test session
*RateTestApi* | [**get_test_metrics**](docs/RateTestApi.md#get_test_metrics) | **GET** /api/test/metrics/{session_id} | Get metrics for a test session
*RateTestApi* | [**receive_test_request**](docs/RateTestApi.md#receive_test_request) | **GET** /api/test/request/{session_id} | Receive a test request
## Documentation For Models
- [CreateSessionRequest](docs/CreateSessionRequest.md)
- [TestMetrics](docs/TestMetrics.md)
- [TestSession](docs/TestSession.md)
- [TimeBucket](docs/TimeBucket.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author
sharmaninenine@gmail.com