https://github.com/0xtim/vapor-clientratelimiter

https://github.com/0xtim/vapor-clientratelimiter

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/0xtim/vapor-clientratelimiter
• Owner: 0xTim
• Created: 2022-07-16T15:59:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-04T11:04:12.000Z (over 2 years ago)
• Last Synced: 2024-05-02T03:18:04.426Z (7 months ago)
• Language: Swift
• Size: 36.1 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vapor Client Rate Limiter

Library for throttling requests to third party APIs to ensure you don't exceed a rate limit. Designed to be used when your application scales across multiple instances. Requires Postgres as it uses database locks to queue requests across instances.

## Usage

Setup in **configure.swift**

```swift

let clientRateLimiterConfig = RateLimiterConfig(maxRequestsPerSecond: 5, timeout: 60)

app.clientRateLimiters.use {

    ClientRateLimiter(byteBufferAllocator: $0.allocator, logger: $0.logger, client: $0.client, db: $0.db, config: clientRateLimiterConfig)

}

```

Add the migrations for storing the data:

```swift

app.migrations.add(CreateHostRequestTime())

app.migrations.add(CreateRateLimitedRequest())

```

You can configure the maximum number of requests per second to send and a timeout for requests if you're under heavy load. Then, route requests through the `clientRateLimiter`: 

```swift

let response = try await req.clientRateLimiter.get("https://www.google.com")

```

### Custom Rate Limits Per Site

There is initial support for allowing different sites to have differnt rate limits. You can configure this when setting up the config like so:

```swift

let clientRateLimiterConfig = RateLimiterConfig(defaultMaxRequestsPerSecond: 5, timeout: 60, siteSpecificRPS: [

    "api.google.com": 100,

    "api.mysite.com": 10

])

```