FastAPI Backend Development Bootcamp · Lekcja

Implementacja WebSockets w FastAPI

Nauczą się Państwo dodawać endpointy WebSocket do aplikacji FastAPI i obsługiwać połączenia.

Implementacja WebSockets w FastAPI to bezpłatna lekcja FastAPI Backend Development Bootcamp na CoddyKit. To lekcja 2 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej FastAPI Backend Development Bootcamp, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs FastAPI Backend Development Bootcamp zawiera 4 lekcji w sumie.

Części tej lekcji nie zostały jeszcze przetłumaczone i są wyświetlane po angielsku.

Real-time with FastAPI WebSockets

Welcome to implementing WebSockets with FastAPI! WebSockets provide a persistent, full-duplex communication channel between a client and a server.

Full-duplex: Both client and server can send and receive messages simultaneously.
Real-time: Ideal for applications needing instant updates, like chat, live dashboards, or gaming.

FastAPI has excellent built-in support for WebSockets, leveraging Python's async/await features.

Defining a WebSocket Endpoint

Just like HTTP endpoints, you define WebSocket endpoints using a decorator. Instead of @app.get() or @app.post(), you use @app.websocket().

Your endpoint function must be async def and accept a websocket: WebSocket parameter. This WebSocket object is your primary tool for interaction.

The first step inside your function is always to await websocket.accept() to establish the connection.

Your First WebSocket Connection

Let's create our first WebSocket endpoint. This simple example accepts a connection, sends a welcome message, and then closes the connection.

Notice the @app.websocket("/ws") decorator and the async def function, which are key for WebSocket handling.

Try running this example and observe the connection:

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    await websocket.send_text("Welcome! Connection established.")
    await websocket.close()

Handling WebSocket Disconnections

WebSocket connections can be interrupted for various reasons (client closes tab, network error). It's crucial to handle these disconnections gracefully.

FastAPI raises a WebSocketDisconnect exception when a client disconnects. You can catch this exception to perform cleanup tasks, like removing the client from a list of active connections.

Wrap your WebSocket communication logic in a try...except WebSocketDisconnect block.

Receiving Messages from Clients

Once connected, your server can receive messages from the client. The WebSocket object provides methods for this:

await websocket.receive_text(): For receiving string data.
await websocket.receive_bytes(): For receiving binary data.
await websocket.receive_json(): For receiving JSON data (requires python-multipart).

These operations are asynchronous, so always use await.

Echoing Client Messages Back

This example demonstrates a simple 'echo' server. It accepts a connection, then continuously receives messages from the client and sends them back.

The while True loop keeps the connection open, and the try...except WebSocketDisconnect handles when the client leaves.

from fastapi import FastAPI, WebSocket, WebSocketDisconnect

app = FastAPI()

@app.websocket("/ws/echo")
async def websocket_echo(websocket: WebSocket):
    await websocket.accept()
    try:
        while True:
            data = await websocket.receive_text()
            print(f"Received from client: {data}")
            await websocket.send_text(f"Server echoed: {data}")
    except WebSocketDisconnect:
        print("Client disconnected.")

Sending Messages to Clients

Similarly, your server can send messages to the client. The WebSocket object offers:

await websocket.send_text("your message"): To send string data.
await websocket.send_bytes(b"your bytes"): To send binary data.
await websocket.send_json({"key": "value"}): To send JSON data.

Remember to await these calls. It's common to send a response right after receiving a message.

Working with JSON Data

For structured data, sending and receiving JSON is preferred. FastAPI's WebSocket object handles serialization/deserialization for you.

Sending: Pass a Python dict to send_json().
Receiving: receive_json() returns a Python dict.

This simplifies data exchange compared to manually parsing strings.

Simple Connection Manager

For applications with multiple clients, you'll need to manage active connections. A common pattern is to use a class to keep track of all connected WebSocket objects.

This manager can then be used to add/remove connections and send messages to specific clients or broadcast to all.

from fastapi import WebSocket

class ConnectionManager:
    def __init__(self):
        self.active_connections: list[WebSocket] = []

    async def connect(self, websocket: WebSocket):
        await websocket.accept()
        self.active_connections.append(websocket)

    def disconnect(self, websocket: WebSocket):
        self.active_connections.remove(websocket)

    async def send_personal_message(self, message: str, websocket: WebSocket):
        await websocket.send_text(message)

# In a real app, you'd integrate 'manager' into your FastAPI endpoint
manager = ConnectionManager()

WebSocket Interaction Check

You've learned the basics of setting up and interacting with WebSocket connections in FastAPI.

Let's check your understanding of accepting new connections.

Recap: Implementing WebSockets

You've successfully learned how to implement WebSockets in FastAPI!

Use @app.websocket() to define endpoints.
Always await websocket.accept() to establish the connection.
Handle disconnections with try...except WebSocketDisconnect.
Use await websocket.receive_text() and await websocket.send_text() for communication.
For structured data, send_json() and receive_json() are your friends.

Next, you'll build a real-time chat application to put these concepts into practice!

Często zadawane pytania

Czy lekcja „Implementacja WebSockets w FastAPI” jest bezpłatna?

Tak — pełny tekst „Implementacja WebSockets w FastAPI” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu FastAPI Backend Development Bootcamp, przejdź na CoddyKit PRO. Kurs FastAPI Backend Development Bootcamp zawiera 4 lekcji w sumie.

Co nauczysz się w „Implementacja WebSockets w FastAPI”?

Nauczą się Państwo dodawać endpointy WebSocket do aplikacji FastAPI i obsługiwać połączenia. Ćwiczysz FastAPI Backend Development Bootcamp z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć FastAPI Backend Development Bootcamp?

Nie wymagamy żadnego doświadczenia. FastAPI Backend Development Bootcamp w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 2 z 4.

Ile czasu zajmuje lekcja „Implementacja WebSockets w FastAPI”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji FastAPI Backend Development Bootcamp?

Tak. Każda lekcja FastAPI Backend Development Bootcamp zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

Podstawy protokołu WebSocket
Implementacja WebSockets w FastAPI
Budowa aplikacji czatu w czasie rzeczywistym
Skalowanie WebSockets za pomocą magistrali Pub/Sub

← Powrót do FastAPI Backend Development Bootcamp