How buvanvarun/url-shortener works
This is a Spring Boot URL-shortening API. Users can register or log in, create links with generated or custom codes, follow redirects, manage owned links, and inspect click analytics. The main path runs from HTTP controllers through services to PostgreSQL and Redis; redirect resolution also records clicks asynchronously. The README documents shared Redis-backed rate limits and JWT ownership. Analytics implementation files and several configuration classes were not sampled, so their internal links are left unverified where source evidence is unavailable.
Main entry points: UrlService.java URL service · UrlRepository.java URL repository · RateLimitFilter.java Rate limit filter · AuthService.java Auth service
Components 23
API and redirects
- URL API
src/main/java/com/buvanvarun/urlshortener/controller/UrlController.java - Redirect endpoint
src/main/java/com/buvanvarun/urlshortener/controller/RedirectController.java - Error responses
src/main/java/com/buvanvarun/urlshortener/exception/GlobalExceptionHandler.java
Identity and limits
- Auth API
src/main/java/com/buvanvarun/urlshortener/controller/AuthController.java - Auth service
src/main/java/com/buvanvarun/urlshortener/service/AuthService.java - JWT service
src/main/java/com/buvanvarun/urlshortener/security/JwtService.java - JWT filter
src/main/java/com/buvanvarun/urlshortener/security/JwtAuthenticationFilter.java - Rate limit filter
src/main/java/com/buvanvarun/urlshortener/ratelimit/RateLimitFilter.java - Bucket resolver
src/main/java/com/buvanvarun/urlshortener/ratelimit/BucketResolver.java - Rate limit settings
src/main/java/com/buvanvarun/urlshortener/config/RateLimitProperties.java - User repository
src/main/java/com/buvanvarun/urlshortener/repository/UserRepository.java
Link management
- URL service
src/main/java/com/buvanvarun/urlshortener/service/UrlService.java - Code generator
src/main/java/com/buvanvarun/urlshortener/service/ShortCodeGeneratorService.java - URL cache
src/main/java/com/buvanvarun/urlshortener/service/UrlCacheService.java - Cache entry
src/main/java/com/buvanvarun/urlshortener/service/UrlCacheEntry.java - URL repository
src/main/java/com/buvanvarun/urlshortener/repository/UrlRepository.java
Click analytics
- Analytics API
src/main/java/com/buvanvarun/urlshortener/controller/AnalyticsController.java - Analytics service
src/main/java/com/buvanvarun/urlshortener/service/AnalyticsService.java - Click tracking
src/main/java/com/buvanvarun/urlshortener/service/ClickTrackingService.java - Click repository
src/main/java/com/buvanvarun/urlshortener/repository/ClickEventRepository.java
Other components
- API user
- PostgreSQL
- Redis
Connections 27
- API user → Auth API: registers or logs in
README.md - Auth API → Auth service: delegates to
src/main/java/com/buvanvarun/urlshortener/controller/AuthController.java - Auth service → User repository: reads and saves
src/main/java/com/buvanvarun/urlshortener/service/AuthService.java - Auth service → JWT service: issues token
src/main/java/com/buvanvarun/urlshortener/service/AuthService.java - API user → URL API: creates and manages links
README.md - URL API → URL service: delegates to
src/main/java/com/buvanvarun/urlshortener/controller/UrlController.java - URL service → Code generator: requests codes
src/main/java/com/buvanvarun/urlshortener/service/UrlService.java - Code generator → URL repository: gets sequence ID
src/main/java/com/buvanvarun/urlshortener/service/ShortCodeGeneratorService.java - URL service → URL repository: reads and writes links
src/main/java/com/buvanvarun/urlshortener/service/UrlService.java - URL repository → PostgreSQL: persists link data
README.md - URL service → URL cache: looks up, caches, evicts
src/main/java/com/buvanvarun/urlshortener/service/UrlService.java - URL cache → Cache entry: stores entries
src/main/java/com/buvanvarun/urlshortener/service/UrlCacheService.java - URL cache → Redis: reads and writes
README.md - API user → Redirect endpoint: follows short link
README.md - Redirect endpoint → URL service: resolves code
src/main/java/com/buvanvarun/urlshortener/controller/RedirectController.java - URL service → Click tracking: records click asynchronously
src/main/java/com/buvanvarun/urlshortener/service/UrlService.java - Click tracking → Click repository: saves click event
src/main/java/com/buvanvarun/urlshortener/service/ClickTrackingService.java - Click tracking → URL repository: increments click count
src/main/java/com/buvanvarun/urlshortener/service/ClickTrackingService.java - Click repository → PostgreSQL: stores events
README.md - API user → Analytics API: requests analytics
README.md - Analytics API → Analytics service: delegates to
src/main/java/com/buvanvarun/urlshortener/controller/AnalyticsController.java - Analytics service → Click repository: queries click metrics
src/main/java/com/buvanvarun/urlshortener/service/AnalyticsService.java - JWT filter → JWT service: parses token
src/main/java/com/buvanvarun/urlshortener/security/JwtAuthenticationFilter.java - Rate limit filter → Bucket resolver: resolves bucket
src/main/java/com/buvanvarun/urlshortener/ratelimit/RateLimitFilter.java - Rate limit filter → Rate limit settings: uses limits
src/main/java/com/buvanvarun/urlshortener/ratelimit/RateLimitFilter.java - Rate limit filter → Redis: shares limit state
README.md - Error responses → API user: returns API errors
src/main/java/com/buvanvarun/urlshortener/exception/GlobalExceptionHandler.java