Hands-On Exercise: Design a Smart Parking REST API
Hands-On Exercise: Design a Smart Parking REST API
animation
rest
protocols
Try It Yourself
NoteHands-On Exercise: Design a Smart Parking REST API
Scenario: Create a REST API for a city parking system with 1,000 parking spots across 10 parking lots. Each spot has a magnetic sensor reporting occupied/vacant status.
Requirements:
The parking API must show live spots, reports, and payments. It must also show offline sensors.
- Mobile app needs real-time spot availability
- City operators need daily/monthly occupancy reports
- Parking enforcement needs to verify payment for specific spots
- System must handle sensor offline gracefully
Tasks:
Name resources and methods first. Then test status codes, link cost, and stale data.
- Design the resource hierarchy (parking lots, spots, sensors, reports)
- Define HTTP endpoints with proper methods (GET, POST, PUT)
- Specify status codes for: spot found occupied, spot not found, sensor offline
- Calculate protocol overhead: Compare HTTP vs CoAP for 1,000 sensors reporting every 30 seconds
- Design offline device handling: What should
GET /lots/3/spots/42/statusreturn if sensor hasn’t reported in 2 hours?
Verification Questions:
Check endpoint coverage, offline status behavior, and daily HTTP versus CoAP traffic to verify the proposed API.
- How many endpoints did you define? (Hint: At least 6-8 for full CRUD operations)
- Did you distinguish between “spot doesn’t exist” (404) and “sensor offline” (200 with stale data)?
- What’s the daily bandwidth consumption difference between HTTP and CoAP for your design?
Sample Solution Sketch:
GET /lots # List all parking lots
GET /lots/{lotId}/spots # List spots in lot
GET /lots/{lotId}/spots/{spotId} # Get specific spot status
PUT /lots/{lotId}/spots/{spotId} # Update spot (internal only)
GET /reports/occupancy?date=... # Occupancy reports
For offline sensors:
GET /lots/3/spots/42 → 200 OK
{
"spot_id": 42,
"status": "occupied",
"last_updated": "2026-02-09T08:15:00Z",
"sensor": {
"status": "offline",
"last_seen": "2026-02-09T08:15:00Z",
"offline_duration_minutes": 120
}
}