* Ces schémas participeront à la constitution du schéma généré OpenAPI, et seront utilisés par les documentations automatiques <abbr title="User Interfaces - Interfaces utilisateur">UIs</abbr>.

## Documentation automatique { #automatic-docs }

Les schémas JSON de vos modèles seront intégrés au schéma OpenAPI global de votre application, et seront donc affichés dans la documentation interactive de l'API :

En particulier, on voit Uvicorn, Starlette et FastAPI comparés (parmi de nombreux autres outils).

Plus le problème résolu par un outil est simple, meilleures seront les performances obtenues. Et la plupart des tests de performance ne prennent pas en compte les fonctionnalités additionnelles fournies par les outils.

La hiérarchie est la suivante :

* **Uvicorn** : un serveur ASGI

Ви можете транслювати дані клієнту за допомогою **Server-Sent Events** (SSE).

Це подібно до [Потік JSON Lines](stream-json-lines.md), але використовує формат `text/event-stream`, який нативно підтримується браузерами через [API `EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).

/// info | Інформація

Додано у FastAPI 0.135.0.

///

# 服务器发送事件（SSE） { #server-sent-events-sse }

你可以使用**服务器发送事件**（SSE）向客户端流式发送数据。

这类似于[流式传输 JSON Lines](stream-json-lines.md)，但使用 `text/event-stream` 格式，浏览器原生通过 [`EventSource` API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) 支持。

/// info | 信息

新增于 FastAPI 0.135.0。

///

## 什么是服务器发送事件？ { #what-are-server-sent-events }

SSE 是一种通过 HTTP 从服务器向客户端流式传输数据的标准。

每个事件是一个带有 `data`、`event`、`id` 和 `retry` 等“字段”的小文本块，以空行分隔。

        assertThat(ZERO.setBit(result)).isAtMost(x);
        assertThat(ZERO.setBit(result + 1)).isGreaterThan(x);
      }
    }
  }

  public void testLog2Ceiling() {
    for (BigInteger x : POSITIVE_BIGINTEGER_CANDIDATES) {
      for (RoundingMode mode : asList(CEILING, UP)) {
        int result = BigIntegerMath.log2(x, mode);
        assertThat(ZERO.setBit(result)).isAtLeast(x);

Vous pouvez déclarer `examples` pour un modèle Pydantic qui seront ajoutés au JSON Schema généré.

{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}

Ces informations supplémentaires seront ajoutées telles quelles au **JSON Schema** de sortie pour ce modèle, et elles seront utilisées dans la documentation de l'API.

        String response = checkGetMethod(searchBody, "").asString();
        final int total = JsonPath.from(response).getInt("response.total");
        final List<Map<String, String>> dicts = JsonPath.from(response).getList("response.settings");
        final int status = JsonPath.from(response).getInt("response.status");
        assertEquals(total, dicts.size());
        assertEquals(0, status);
    }

    @Override

        assertEquals(1, JsonPath.from(response).getInt("response.status"));

        // Test PUT /api/admin/crawlinginfo/logs
        final Map<String, Object> putBody = new HashMap<>();
        putBody.put("size", 10);
        response = checkMethodBase(putBody).put("/api/admin/crawlinginfo/logs").asString();
        assertEquals(0, JsonPath.from(response).getInt("response.status"));

Vous pouvez déclarer des informations supplémentaires dans `Field`, `Query`, `Body`, etc. Elles seront incluses dans le JSON Schema généré.

Vous en apprendrez davantage sur l'ajout d'informations supplémentaires plus loin dans les documents, lorsque vous apprendrez à déclarer des exemples.

/// warning | Alertes

Les clés supplémentaires passées à `Field` seront également présentes dans le schéma OpenAPI résultant pour votre application.

Le *décorateur de chemin d'accès* accepte un argument optionnel `dependencies`.

Il doit s'agir d'une `list` de `Depends()` :

{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *}

Ces dépendances seront exécutées/résolues de la même manière que des dépendances normales. Mais leur valeur (si elles en retournent une) ne sera pas transmise à votre *fonction de chemin d'accès*.

/// tip | Astuce