FastAPI's WebSocket support, provided by Starlette and importable from fastapi.
Field note
Declare a WebSocket parameter to read data from and send data to clients, with connection state and message helpers.
Capabilities
Tags
Ways to use it
python / fastapi
python / fastapi
Product features
Async accept and close methods to manage the connection.
WebSocket class with scope, app, url, base_url, headers, query_params, path_params, cookies, client, state attributes.
iter_text, iter_bytes, iter_json for iterating incoming messages.
Async receive and send methods for raw messages.
receive_text, receive_bytes, receive_json, send_text, send_bytes, send_json.
url_for method on the WebSocket.
Additional class with code and reason attributes.
States CONNECTING, CONNECTED, DISCONNECTED, RESPONSE.