How allaingaye/url-shortener works
This Laravel URL-shortener API handles account/token workflows, URL creation and management, public redirects, and click analytics. A redirect resolves an active, unexpired code through the URL service, increments its counter, queues detailed click capture, and returns a 302. The README also documents rate limiting, security headers, API documentation, and daily expiration pruning. Source excerpts establish the main redirect and asynchronous analytics calls; several API routes and integrations are represented only by README statements or the source index, so uncertain implementation links are omitted.
Main entry points: api.php API routes · UrlController.php URL management · RedirectController.php Redirect handler · UrlService.php URL service
Components 22
API and access
- API routes
routes/api.php - Account and tokens
app/Http/Controllers/Api/AuthController.php - User accounts
app/Models/User.php - URL ownership policy
app/Policies/UrlPolicy.php
Link lifecycle
- URL management
app/Http/Controllers/Api/UrlController.php - URL validation
app/Http/Requests - URL service
app/Services/UrlService.php - Code generator
app/Services/ShortCodeGenerator.php - URL records
app/Models/Url.php - URL response
app/Http/Resources/UrlResource.php - Redirect route
routes/web.php - Redirect handler
app/Http/Controllers/RedirectController.php - Expired URL pruning
app/Console/Commands/PruneExpiredUrls.php
Click analytics
- Click job
app/Jobs/RecordClick.php - Analytics capture
app/Services/AnalyticsService.php - Click records
app/Models/Click.php - Analytics endpoint
app/Http/Controllers/Api/UrlStatsController.php
Runtime safeguards
- Security headers
app/Http/Middleware/SecurityHeaders.php - Rate limiting
routes/api.php - OpenAPI documentation
app/OpenApi/OpenApi.php
Other components
- API client
- Link visitor
Connections 24
- API client → API routes: calls API
- API routes → Account and tokens: routes auth
routes/api.php - Account and tokens → User accounts: creates and authenticates
app/Http/Controllers/Api/AuthController.php - API routes → URL management: routes URL operations
routes/api.php - URL management → URL validation: validates input
app/Http/Controllers/Api/UrlController.php - URL management → URL service: delegates URL actions
app/Http/Controllers/Api/UrlController.php - URL service → Code generator: generates codes
app/Services/UrlService.php - URL service → URL records: creates and resolves
app/Services/UrlService.php - URL management → URL response: formats responses
app/Http/Controllers/Api/UrlController.php - URL management → URL ownership policy: authorizes ownership
- Link visitor → Redirect route: requests short link
- Redirect route → Redirect handler: dispatches redirect
routes/web.php - Redirect handler → URL service: resolves code
app/Http/Controllers/RedirectController.php - Redirect handler → URL records: increments clicks
app/Http/Controllers/RedirectController.php - Redirect handler → Click job: dispatches click
app/Http/Controllers/RedirectController.php - Click job → Analytics capture: records event
app/Jobs/RecordClick.php - Analytics capture → Click records: persists click details
app/Services/AnalyticsService.php - API routes → Analytics endpoint: routes statistics
routes/api.php - Analytics endpoint → Click records: aggregates click data
app/Http/Controllers/Api/UrlStatsController.php - Analytics endpoint → URL ownership policy: checks URL ownership
- Expired URL pruning → URL records: prunes expired URLs
app/Console/Commands/PruneExpiredUrls.php - Security headers → API routes: protects requests
- Rate limiting → API routes: limits requests
routes/api.php - OpenAPI documentation → API client: documents API