mirror/fastapi
1
0
Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-03-04 06:58:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

✨ Re-export Starlette's WebSocketException and add it to docs (#5629)

Browse Source
This commit is contained in:
Sebastián Ramírez
2022-11-13 17:10:54 +01:00
committed by GitHub
parent 1c93d5523a
commit d537ee93d7
4 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -112,17 +112,15 @@ In WebSocket endpoints you can import from `fastapi` and use:
They work the same way as for other FastAPI endpoints/*path operations*:
```Python hl_lines="58-65 68-83"
```Python hl_lines="66-77 76-91"
{!../../../docs_src/websockets/tutorial002.py!}
```
!!! info
In a WebSocket it doesn't really make sense to raise an `HTTPException`. So it's better to close the WebSocket connection directly.
As this is a WebSocket it doesn't really make sense to raise an `HTTPException`, instead we raise a `WebSocketException`.
You can use a closing code from the <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">valid codes defined in the specification</a>.
In the future, there will be a `WebSocketException` that you will be able to `raise` from anywhere, and add exception handlers for it. It depends on the <a href="https://github.com/encode/starlette/pull/527" class="external-link" target="_blank">PR #527</a> in Starlette.
### Try the WebSockets with dependencies
If your file is named `main.py`, run your application with: