happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Update includes in `docs/en/docs/advanced/websockets.md` (#12606)

This commit is contained in:
VISHNU V S 2024-11-09 18:55:07 +05:30 committed by GitHub
parent 64204dc2b1
commit ffcb635c2a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/en/docs/advanced/websockets.md
View File

@ -38,17 +38,13 @@ In production you would have one of the options above.
But it's the simplest way to focus on the server-side of WebSockets and have a working example:
```Python hl_lines="2 6-38 41-43"
{!../../docs_src/websockets/tutorial001.py!}
```
{* ../../docs_src/websockets/tutorial001.py hl[2,6:38,41:43] *}
## Create a `websocket`
In your **FastAPI** application, create a `websocket`:
```Python hl_lines="1 46-47"
{!../../docs_src/websockets/tutorial001.py!}
```
{* ../../docs_src/websockets/tutorial001.py hl[1,46:47] *}
/// note | "Technical Details"
@ -62,9 +58,7 @@ You could also use `from starlette.websockets import WebSocket`.
In your WebSocket route you can `await` for messages and send messages.
```Python hl_lines="48-52"
{!../../docs_src/websockets/tutorial001.py!}
```
{* ../../docs_src/websockets/tutorial001.py hl[48:52] *}
You can receive and send binary, text, and JSON data.
@ -115,57 +109,7 @@ In WebSocket endpoints you can import from `fastapi` and use:
They work the same way as for other FastAPI endpoints/*path operations*:
//// tab | Python 3.10+
```Python hl_lines="68-69 82"
{!> ../../docs_src/websockets/tutorial002_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="68-69 82"
{!> ../../docs_src/websockets/tutorial002_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="69-70 83"
{!> ../../docs_src/websockets/tutorial002_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="66-67 79"
{!> ../../docs_src/websockets/tutorial002_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="68-69 81"
{!> ../../docs_src/websockets/tutorial002.py!}
```
////
{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
/// info
@ -210,21 +154,7 @@ With that you can connect the WebSocket and then send and receive messages:
When a WebSocket connection is closed, the `await websocket.receive_text()` will raise a `WebSocketDisconnect` exception, which you can then catch and handle like in this example.
//// tab | Python 3.9+
```Python hl_lines="79-81"
{!> ../../docs_src/websockets/tutorial003_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="81-83"
{!> ../../docs_src/websockets/tutorial003.py!}
```
////
{* ../../docs_src/websockets/tutorial003_py39.py hl[79:81] *}
To try it out: