https://github.com/j-sephb-lt-n/rate-limiter-token-bucket-algorithm

An example implementation of the token-bucket algorithm for API rating limiting using python, redis and FastAPI
https://github.com/j-sephb-lt-n/rate-limiter-token-bucket-algorithm

api fastapi rate-limiting redis token-bucket

Last synced: about 23 hours ago
JSON representation

An example implementation of the token-bucket algorithm for API rating limiting using python, redis and FastAPI

• Host: GitHub
• URL: https://github.com/j-sephb-lt-n/rate-limiter-token-bucket-algorithm
• Owner: J-sephB-lt-n
• License: gpl-3.0
• Created: 2023-11-02T19:21:08.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-05T10:27:27.000Z (about 1 year ago)
• Last Synced: 2024-04-17T22:57:31.404Z (7 months ago)
• Topics: api, fastapi, rate-limiting, redis, token-bucket
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rate-limiter-token-bucket-algorithm

An example implementation of the [token-bucket algorithm]() for API rating-limiting, using python, redis and FastAPI.

The concept is very simple: Users acquire tokens at a fixed rate (up to a maximum number of tokens) and then consume a single token with each API request. If a user has no tokens at request time, then they receive a 

**429: Too Many Requests** 

response to their request. This algorithm could be adapted to allow for different request sizes to consume different numbers of tokens (or fractions of tokens). 

Start redis database and fastAPI servers in the background:

```bash

redis-server --daemonize yes

nohup uvicorn main:app --port 8000 &

```

Run a simple test case: 

```bash

python run_random_test_case.py

```

```

user_id=joe request@21:02:33 response_status_code: 200 response: OK

user_id=joe request@21:02:33 response_status_code: 200 response: OK

user_id=joe request@21:02:34 response_status_code: 200 response: OK

user_id=joe request@21:02:35 response_status_code: 200 response: OK

user_id=joe request@21:02:36 response_status_code: 200 response: OK

user_id=joe request@21:02:37 response_status_code: 200 response: OK

user_id=joe request@21:02:37 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:38 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:39 response_status_code: 200 response: OK

user_id=joe request@21:02:40 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:41 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:43 response_status_code: 200 response: OK

user_id=joe request@21:02:44 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:45 response_status_code: 200 response: OK

user_id=joe request@21:02:47 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:48 response_status_code: 200 response: OK

user_id=joe request@21:02:49 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:50 response_status_code: 429 response: Too Many Requests

user_id=joe request@21:02:52 response_status_code: 200 response: OK

user_id=joe request@21:02:53 response_status_code: 429 response: Too Many Requests

```

Stop the redis database and fastAPI servers, and clean up:

```bash

redis-cli shutdown

rm dump.rdb

UVICORN_PID=$(pgrep -f "uvicorn main:app")

kill -15 $UVICORN_PID

rm nohup.out

```