*/
    public fun webSocketUpgrade(listener: WebSocketListener): Builder =
      apply {
        status = "HTTP/1.1 101 Switching Protocols"
        setHeader("Connection", "Upgrade")
        setHeader("Upgrade", "websocket")
        webSocketListener = listener
      }

    /**
     * Configures this response to be served as a response to an HTTP CONNECT request, either for

{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}

## Создание `websocket` { #create-a-websocket }

Создайте `websocket` в своем **FastAPI** приложении:

{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}

/// note | Технические детали

Вы также можете использовать `from starlette.websockets import WebSocket`.

# WebSockets { #websockets }

Você pode usar [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) com **FastAPI**.

## Instale `websockets` { #install-websockets }

Garanta que você criou um [ambiente virtual](../virtual-environments.md), o ativou e instalou o `websockets` (uma biblioteca Python que facilita o uso do protocolo "WebSocket"):

<div class="termy">

```console
$ pip install websockets

---> 100%
```

它也是最早生成一个自定义 JSON 模式来声明整个 API 的框架之一。

它并不基于 OpenAPI 与 JSON Schema 这类标准。因此与其他工具（如 Swagger UI）的集成并非一帆风顺。但它仍是非常有创新性的想法。

它有一个有趣且少见的特性：使用同一框架，可以同时创建 API 与 CLI。

由于基于同步 Python Web 框架的上一代标准（WSGI），它无法处理 WebSocket 等，尽管它的性能仍然很高。

/// info | 信息

Hug 由 Timothy Crosley 创建，他也是 [`isort`](https://github.com/timothycrosley/isort) 的作者，这是一个能自动排序 Python 文件中导入的优秀工具。

///

/// check | 启发 **FastAPI** 的想法：

github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4=
github.com/gorilla/sessions v1.2.1/go.mod h1:dk2InVEVJ0sfLlnXv9EAgkf6ecYs/i80K/zI+bUmuGM=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=

# Тестування WebSocket { #testing-websockets }

Ви можете використовувати той самий `TestClient` для тестування WebSocket.

Для цього використайте `TestClient` в інструкції `with`, підключаючись до WebSocket:

{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *}

/// note | Примітка

Докладніше дивіться документацію Starlette щодо [тестування WebSocket](https://www.starlette.dev/testclient/#testing-websocket-sessions).

**FastAPI** では **Starlette** のすべての機能が利用できます（FastAPI は強化された Starlette にすぎません）:

* 圧倒的なパフォーマンス。[利用可能な最速クラスの Python フレームワークの 1 つで、**NodeJS** や **Go** と同等です](https://github.com/encode/starlette#performance)。
* **WebSocket** のサポート。
* プロセス内バックグラウンドタスク。
* 起動およびシャットダウンイベント。
* HTTPX に基づくテストクライアント。
* **CORS**、GZip、静的ファイル、ストリーミングレスポンス。
* **セッションと Cookie** のサポート。
* テストカバレッジ 100%。
* 型アノテーション 100% のコードベース。

# WebSocket のテスト { #testing-websockets }

WebSocket をテストするのにも同じ `TestClient` を使用できます。

そのために、`with` 文の中で `TestClient` を使用し、WebSocket に接続します:

{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *}

/// note | 備考

詳細については、Starlette のドキュメント「[WebSocket のテスト](https://www.starlette.dev/testclient/#testing-websocket-sessions)」を参照してください。

# Probando WebSockets { #testing-websockets }

Puedes usar el mismo `TestClient` para probar WebSockets.

Para esto, usas el `TestClient` en un statement `with`, conectándote al WebSocket:

{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *}

/// note | Nota

Para más detalles, revisa la documentación de Starlette sobre [probar WebSockets](https://www.starlette.dev/testclient/#testing-websocket-sessions).

# Testando WebSockets { #testing-websockets }

Você pode usar o mesmo `TestClient` para testar WebSockets.

Para isso, você utiliza o `TestClient` dentro de uma instrução `with`, conectando com o WebSocket:

{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *}

/// note | Nota

Para mais detalhes, confira a documentação do Starlette para [testar WebSockets](https://www.starlette.dev/testclient/#testing-websocket-sessions).