WebSockets with RESTful APIs
Design hybrid architectures where WebSockets complement traditional REST APIs for dynamic updates.
WebSockets with RESTful APIs is a free WebSockets & Realtime Systems Programming lesson on CoddyKit — lesson 1 of 3. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the WebSockets & Realtime Systems Programming learning path, one of 3 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Why Hybrid Architectures?
Welcome! In this lesson, we'll explore how to combine two powerful web communication tools: RESTful APIs and WebSockets.
While both facilitate communication, they excel in different areas. A hybrid approach leverages their individual strengths to build robust, dynamic applications.
- REST for initial data loading and traditional resource management.
- WebSockets for instant, real-time data updates.
RESTful APIs: The Foundation
RESTful APIs are a cornerstone of modern web development. They follow a request-response model, typically over HTTP.
Think of them as ordering from a menu: you make a specific request (e.g., "Get me all products"), and the server responds with the data. They are great for:
- Fetching static or infrequently changing data.
- Performing one-time actions (creating, updating, deleting resources).
- Initial page loads with existing information.
WebSockets: Real-time Dynamics
WebSockets, as you've learned, provide a persistent, full-duplex connection. This means data can flow simultaneously in both directions, without constant new requests.
They are like a live chat: once connected, messages can be sent back and forth instantly. This makes them perfect for:
- Live data feeds (stock prices, sports scores).
- Real-time notifications (new messages, activity alerts).
- Collaborative applications (document editing).
Complementary, Not Competing
It's important to see REST and WebSockets as complementary tools, not competitors. They solve different problems efficiently.
Combining them allows you to handle both traditional data operations and real-time interactions within the same application, leading to a richer user experience.
A well-designed hybrid system uses each protocol where it makes the most sense.
The Hybrid Workflow
A common hybrid workflow looks like this:
- Client loads: Makes initial requests via REST to fetch existing data (e.g., a list of items).
- Client connects: Establishes a WebSocket connection for real-time updates related to that data.
- Server updates: Pushes new data or changes via WebSocket as they occur.
- Client interacts: Might use REST for specific resource actions (e.g., 'mark item as complete') and receive confirmation/updates via WebSocket.
Server: REST Endpoint for Data
First, let's set up a simple Node.js server with an Express REST endpoint. This endpoint will serve our initial list of 'items'.
This demonstrates how a client would initially fetch existing data. (Remember to npm install express)
const express = require('express');
const app = express();
const PORT = 3000;
let items = [
{ id: 1, name: 'Item A', status: 'pending' },
{ id: 2, name: 'Item B', status: 'completed' }
];
// REST endpoint to get all items
app.get('/api/items', (req, res) => {
res.json(items);
});
app.listen(PORT, () => {
console.log(`REST server listening on port ${PORT}`);
});
Server: Adding WebSocket Updates
Now, let's extend our server to include a WebSocket. This WebSocket will push real-time updates whenever an item's status changes.
We use the ws library and integrate it with our existing Express server. (Remember to npm install ws)
const express = require('express');
const WebSocket = require('ws');
const http = require('http');
const app = express();
const server = http.createServer(app);
const wss = new WebSocket.Server({ server });
const PORT = 3000;
let items = [
{ id: 1, name: 'Item A', status: 'pending' },
{ id: 2, name: 'Item B', status: 'completed' }
];
// REST endpoint to get all items
app.get('/api/items', (req, res) => {
res.json(items);
});
// WebSocket connection handling
wss.on('connection', ws => {
console.log('Client connected via WebSocket');
// Simulate an item update every 5 seconds
const interval = setInterval(() => {
const itemToUpdate = items[Math.floor(Math.random() * items.length)];
itemToUpdate.status = itemToUpdate.status === 'pending' ? 'completed' : 'pending';
const updateMessage = JSON.stringify({ type: 'itemUpdate', item: itemToUpdate });
wss.clients.forEach(client => {
if (client.readyState === WebSocket.OPEN) {
client.send(updateMessage);
}
});
}, 5000);
ws.on('close', () => {
console.log('Client disconnected');
clearInterval(interval);
});
});
server.listen(PORT, () => {
console.log(`Hybrid server listening on port ${PORT}`);
});
Client: Fetching Initial Data (JS)
On the client-side (e.g., in a web browser), you'd first use fetch or XMLHttpRequest to get the initial list of items from the REST API.
This ensures the user sees existing data immediately.
async function getInitialItems() {
try {
const response = await fetch('http://localhost:3000/api/items');
const data = await response.json();
console.log('Initial items (REST):', data);
// Render initial items on the UI
} catch (error) {
console.error('Error fetching items:', error);
}
}
getInitialItems();
Client: Subscribing to Live Updates (JS)
After fetching initial data, the client opens a WebSocket connection to receive real-time updates. When a message arrives, it can update the UI dynamically.
This keeps the displayed data fresh without constant page refreshes.
const ws = new WebSocket('ws://localhost:3000');
ws.onopen = () => {
console.log('WebSocket connected!');
};
ws.onmessage = event => {
const message = JSON.parse(event.data);
if (message.type === 'itemUpdate') {
console.log('Real-time item update:', message.item);
// Update the specific item on the UI
}
};
ws.onclose = () => {
console.log('WebSocket disconnected.');
};
ws.onerror = error => {
console.error('WebSocket error:', error);
};
Hybrid Use Cases
Which communication method is best for each scenario in a hybrid application?
Recap: Best of Both Worlds
You've learned how to design hybrid architectures that combine RESTful APIs and WebSockets.
- REST excels for initial data loading and traditional CRUD operations due to its stateless, request-response nature.
- WebSockets are perfect for instant, bidirectional communication, providing dynamic updates and real-time interactions.
By strategically using both, you can build performant and highly interactive applications. Next, we'll look at bridging WebSockets to message queues.
Frequently asked questions
Is the “WebSockets with RESTful APIs” lesson free?
Yes — the full text of “WebSockets with RESTful APIs” is free to read here on the web, and the WebSockets & Realtime Systems Programming course includes 3 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the WebSockets & Realtime Systems Programming course, upgrade to CoddyKit PRO.
What will I learn in “WebSockets with RESTful APIs”?
Design hybrid architectures where WebSockets complement traditional REST APIs for dynamic updates. You practise WebSockets & Realtime Systems Programming with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start WebSockets & Realtime Systems Programming?
No prior experience is required. WebSockets & Realtime Systems Programming on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 3, so you can start here or from the beginning and move at your own pace.
How long does the “WebSockets with RESTful APIs” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this WebSockets & Realtime Systems Programming lesson?
Yes. Every WebSockets & Realtime Systems Programming lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- WebSockets with RESTful APIs
- Bridging to Message Queues
- Streaming Database Changes to Clients