oluwasegun-aa / ratelimiter

Rate Limiter

Table of Contents

• Project Overview
• Features
• Environment Variables
• Test
• Screenshot

Project-Overview

This repo exemplifies API rate limiting, using the token bucket algorithm. the rate limitter implementation can be found in middlewares/rateLimiter/limitRate

Features

• Allows for rate limit specification
• Allows for limit time range customisation
• provides hard throttling when rate limit exceeded
• Extendable

Environment Variables

To run this project, you will need to add the following environment variables to your .env file if you choose to run locally

• Required
  • DATABASE_URL=string (databaseUrl)
  • SECRET=string (Jwt secret)

Test

• How To:

  • Automated test can be run using yarn test (this will require env variables)
  • The rate limiting functionality is tested by making recurrent request to the endpoints. It has been configured such that the API allows a max of 10 requests per client within a duration of 1 mminute. After 10 successful requests, Error 429 is retuned. Also, the rate limit information is returned in the headers.

• Local env test [ Downlad Postman Collection ]

  • clone repo
  • create a .env file and supply the env variables in .env.sample
  • run yarn start
  • make request to:
    • localhost:5000/api/v1/auth/signup
    • localhost:5000/api/v1/auth/signup
    • localhost:5000/api/v1/mail

• Remote Ephemeral server test [ Downlad Postman Collection ]

  • Downlad Postman Collection or click run in postman below
  • make request to:
    • https://ratelimiter-production.up.railway.app/api/v1/auth/signup
    • https://ratelimiter-production.up.railway.app/api/v1/auth/signup
    • https://ratelimiter-production.up.railway.app/api/v1/mail

Note: the postman requests prepended with the "Local" keyword are to be used for local testing only

Screenshot

Unthrottled maiden request headers

Throttled request headers

---

This File was generated by md-generator