Why WebSockets enable real-time communication in FastAPI - See It in Action

Why WebSockets Enable Real-Time Communication

📖 Scenario: You are building a simple chat server using FastAPI. You want to understand how WebSockets help send messages instantly between clients without waiting for page reloads.

🎯 Goal: Create a FastAPI app that sets up a WebSocket endpoint to accept connections and broadcast messages to all connected clients in real time.

📋 What You'll Learn

Create a FastAPI app instance named app

Create a list called connections to store active WebSocket connections

Add a WebSocket route at /ws that accepts connections

Implement logic to receive messages from one client and send them to all connected clients immediately

💡 Why This Matters

🌍 Real World

WebSockets are used in chat apps, live notifications, online games, and any app needing instant updates without page reloads.

💼 Career

Understanding WebSockets is key for backend developers building real-time features and for full-stack developers integrating live user experiences.

1

Create FastAPI app and connections list

Create a FastAPI app instance called app and a list called connections to hold active WebSocket connections.

FastAPI

from fastapi import FastAPI, WebSocket

# Your code here

Hint

Use app = FastAPI() to create the app and connections = [] to store WebSocket clients.

2

Add WebSocket endpoint at /ws

Add a WebSocket route at /ws using @app.websocket("/ws") and define an async function websocket_endpoint that accepts a websocket parameter of type WebSocket. Inside, accept the connection with await websocket.accept().

FastAPI

from fastapi import FastAPI, WebSocket

app = FastAPI()
connections = []

# Your code here

Hint

Use @app.websocket("/ws") decorator and inside the function call await websocket.accept() to accept the connection.

3

Add connection to list and broadcast messages

Inside websocket_endpoint, add the websocket to the connections list. Then create a while True loop to receive messages with data = await websocket.receive_text(). For each message, send it to all websockets in connections using await connection.send_text(data).

FastAPI

from fastapi import FastAPI, WebSocket

app = FastAPI()
connections = []

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    # Your code here

Hint

Remember to add the websocket to connections and use a loop to receive and broadcast messages.

4

Handle disconnects and remove connections

Wrap the message receiving and sending loop in a try block. Use except WebSocketDisconnect to catch disconnects and remove the websocket from connections with connections.remove(websocket).

FastAPI

from fastapi import FastAPI, WebSocket
from fastapi.websockets import WebSocketDisconnect

app = FastAPI()
connections = []

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    connections.append(websocket)
    # Your code here

Hint

Use try and except WebSocketDisconnect to handle client disconnects and remove them from the list.

Practice

1. Why do WebSockets enable real-time communication in FastAPI applications?

easy

A. Because they only send data from server to client once

B. Because they use HTTP requests repeatedly to fetch new data

C. Because they keep a constant open connection for instant two-way data exchange

D. Because they require manual page refresh to update data

Solution

1. Step 1: Understand WebSocket connection behavior

   WebSockets maintain a persistent connection allowing continuous data flow without reconnecting.

2. Step 2: Compare with HTTP request-response model

   Unlike HTTP, which closes after each request, WebSockets allow instant two-way communication.

3. Final Answer:

   Because they keep a constant open connection for instant two-way data exchange -> Option C

4. Quick Check:

   Persistent connection = real-time communication [OK]

Hint: Remember: WebSockets keep connection open for instant updates [OK]

Common Mistakes:

• Confusing WebSockets with repeated HTTP requests
• Thinking WebSockets only send data one way
• Assuming page refresh is needed for updates

2. Which of the following is the correct way to define a WebSocket route in FastAPI?

easy

A. app.websocket('/ws') async def websocket_endpoint(websocket): await websocket.accept()

B. app.get('/ws') async def websocket_endpoint(websocket): await websocket.accept()

C. app.post('/ws') def websocket_endpoint(websocket): websocket.accept()

D. app.websocket('/ws') def websocket_endpoint(): websocket.accept()

Solution

1. Step 1: Identify correct decorator and async function

   FastAPI uses @app.websocket decorator and async def for WebSocket routes.

2. Step 2: Confirm usage of await websocket.accept()

   Accepting the connection requires awaiting websocket.accept() inside async function.

3. Final Answer:

   app.websocket('/ws') async def websocket_endpoint(websocket): await websocket.accept() -> Option A

4. Quick Check:

   Use @app.websocket + async + await accept() [OK]

Hint: WebSocket routes need @app.websocket and async functions [OK]

Common Mistakes:

• Using HTTP method decorators like @app.get for WebSockets
• Forgetting async or await keywords
• Defining function without websocket parameter

3. Given this FastAPI WebSocket code snippet, what will the client receive after sending 'hello'?

from fastapi import FastAPI, WebSocket
app = FastAPI()

@app.websocket('/ws')
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    data = await websocket.receive_text()
    await websocket.send_text(f'Received: {data}')

medium

A. 'hello'

B. Error: websocket not accepted

C. No response, connection closed

D. 'Received: hello'

Solution

1. Step 1: Analyze the receive and send calls

   The server waits for text, receives 'hello', then sends back 'Received: hello'.

2. Step 2: Confirm connection acceptance

   websocket.accept() is awaited, so connection is open and ready for communication.

3. Final Answer:

   'Received: hello' -> Option D

4. Quick Check:

   Server echoes with prefix 'Received:' [OK]

Hint: Look for send_text with formatted string after receive_text [OK]

Common Mistakes:

• Assuming no response is sent
• Ignoring the awaited accept() call
• Confusing received data with sent data

4. What is wrong with this FastAPI WebSocket handler code?

@app.websocket('/ws')
async def websocket_endpoint(websocket: WebSocket):
    data = await websocket.receive_text()
    await websocket.accept()
    await websocket.send_text(f'Got: {data}')

medium

A. Incorrect route decorator used

B. Calling receive_text before accepting the connection

C. Using send_text instead of send_bytes

D. Missing async keyword in function definition

Solution

1. Step 1: Check order of accept and receive calls

   WebSocket connection must be accepted before receiving data.

2. Step 2: Identify the error caused by wrong order

   Calling receive_text before accept() causes runtime error as connection is not open yet.

3. Final Answer:

   Calling receive_text before accepting the connection -> Option B

4. Quick Check:

   Accept connection before receiving data [OK]

Hint: Always await websocket.accept() before receiving messages [OK]

Common Mistakes:

• Receiving data before accepting connection
• Forgetting async keyword
• Confusing send_text with send_bytes

5. You want to build a live chat app using FastAPI WebSockets. Which approach best ensures real-time updates to all connected clients?

hard

A. Keep a list of connected WebSocket objects and broadcast messages to all

B. Send HTTP requests every second to fetch new messages

C. Open a new WebSocket connection for each message sent

D. Use a database trigger to push messages without WebSockets

Solution

1. Step 1: Understand real-time broadcast requirement

   To update all clients instantly, server must send messages to all open connections.

2. Step 2: Identify best method for broadcasting

   Maintaining a list of connected WebSocket objects allows sending messages to all clients immediately.

3. Final Answer:

   Keep a list of connected WebSocket objects and broadcast messages to all -> Option A

4. Quick Check:

   Broadcast via open WebSocket connections = real-time updates [OK]

Hint: Broadcast by storing and sending to all connected sockets [OK]

Common Mistakes:

• Using repeated HTTP polling instead of WebSockets
• Opening new connections per message wastes resources
• Relying on database triggers without WebSocket communication