How ramantiw45/api-rate-limiter works
This is a reactive API rate-limiting gateway: clients send protected echo requests, API keys are validated and stripped, requests are bucketed by client identity in Redis, and surviving traffic is proxied under timeout/circuit-breaker protection. Logging/tracing and actuator security are additional product capabilities. Rate-limit route wiring, observability configuration, and Redis HA details are documented in the README but their implementation paths were not sampled; their links are therefore documented or left unverified.
Main entry points: RateLimiterConfig.java Token bucket limiter · ResilienceConfig.java Circuit breaker and timeout · ApiKeyValidationFilter.java API key filter · ApiRateLimiterApplication.java Reactive gateway
Components 20
Gateway ingress
- Reactive gateway
src/main/java/com/api/ratelimiter/ApiRateLimiterApplication.java - Request tracing
src/main/java/com/api/ratelimiter/filter/GlobalLoggingFilter.java
Traffic protection
- Client key resolution
src/main/java/com/api/ratelimiter/config/KeyResolverConfig.java - Token bucket limiter
src/main/java/com/api/ratelimiter/config/RateLimiterConfig.java - Redis rate state
- Circuit breaker and timeout
src/main/java/com/api/ratelimiter/config/ResilienceConfig.java - Breaker properties
src/main/java/com/api/ratelimiter/config/CircuitBreakerProperties.java - 503 fallback
src/main/java/com/api/ratelimiter/controller/FallbackController.java - Rate-limit error handling
src/main/java/com/api/ratelimiter/filter/RateLimitErrorFilter.java
Identity security
- API key filter
src/main/java/com/api/ratelimiter/filter/ApiKeyValidationFilter.java - Key validator
src/main/java/com/api/ratelimiter/security/ApiKeyValidator.java - Key hashing
src/main/java/com/api/ratelimiter/security/ApiKeyHasher.java - Security properties
src/main/java/com/api/ratelimiter/config/GatewaySecurityProperties.java - Actuator access control
src/main/java/com/api/ratelimiter/config/SecurityConfig.java
Operations and telemetry
- Prometheus metrics
- Grafana dashboards
docker/grafana/dashboards/rate-limiter-dashboard.json - Zipkin tracing
- Redis Sentinel HA
docker-compose.ha.yml
Other components
- API client
- Echo upstream service
Connections 21
- API client → Reactive gateway: sends requests
README.md - Reactive gateway → Request tracing: enters filter
- Request tracing → API key filter: continues chain
src/main/java/com/api/ratelimiter/filter/GlobalLoggingFilter.java - API key filter → Key validator: validates key
src/main/java/com/api/ratelimiter/filter/ApiKeyValidationFilter.java - Key validator → Key hashing: hashes candidate
src/main/java/com/api/ratelimiter/security/ApiKeyValidator.java - Key validator → Security properties: loads digest settings
src/main/java/com/api/ratelimiter/security/ApiKeyValidator.java - API key filter → Key hashing: stores identity hash
src/main/java/com/api/ratelimiter/filter/ApiKeyValidationFilter.java - API key filter → Client key resolution: passes validated identity
src/main/java/com/api/ratelimiter/config/KeyResolverConfig.java - Client key resolution → Key hashing: hashes fallback key
src/main/java/com/api/ratelimiter/config/KeyResolverConfig.java - Client key resolution → Token bucket limiter: provides client key
- Token bucket limiter → Redis rate state: checks token bucket
README.md - Token bucket limiter → Rate-limit error handling: rejects exhausted bucket
- Token bucket limiter → Circuit breaker and timeout: permits requests onward
README.md - Circuit breaker and timeout → Breaker properties: loads breaker settings
src/main/java/com/api/ratelimiter/config/ResilienceConfig.java - Circuit breaker and timeout → Echo upstream service: proxies protected calls
README.md - Circuit breaker and timeout → 503 fallback: dispatches on failure
src/main/java/com/api/ratelimiter/controller/FallbackController.java - Actuator access control → Security properties: loads access settings
src/main/java/com/api/ratelimiter/config/SecurityConfig.java - Reactive gateway → Prometheus metrics: exposes metrics
README.md - Prometheus metrics → Grafana dashboards: feeds dashboards
README.md - Request tracing → Zipkin tracing: propagates trace context
README.md - Redis Sentinel HA → Redis rate state: manages failover
README.md