FastApi - Code Search

docs/zh/docs/tutorial/cookie-param-models.md

这将允许您在**多个地方**能够**重用模型**，并且可以一次性声明所有参数的验证方式和元数据。😎

/// note

自 FastAPI 版本 `0.115.0` 起支持此功能。🤓

///

/// tip

此技术同样适用于 `Query` 、 `Cookie` 和 `Header` 。😎

///

## 带有 Pydantic 模型的 Cookie

在 **Pydantic** 模型中声明所需的 **cookie** 参数，然后将参数声明为 `Cookie` ：

{* ../../docs_src/cookie_param_models/tutorial001_an_py310.py hl[9:12,16] *}

**FastAPI** 将从请求中接收到的 **cookie** 中**提取**出**每个字段**的数据，并提供您定义的 Pydantic 模型。

## 查看文档

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Tue Dec 10 20:38:03 GMT 2024

- 3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ru/docs/tutorial/encoder.md

В некоторых случаях может потребоваться преобразование типа данных (например, Pydantic-модели) в тип, совместимый с JSON (например, `dict`, `list` и т.д.).

Например, если необходимо хранить его в базе данных.

Для этого **FastAPI** предоставляет функцию `jsonable_encoder()`.

## Использование `jsonable_encoder` { #using-the-jsonable-encoder }

Представим, что у вас есть база данных `fake_db`, которая принимает только JSON-совместимые данные.

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Tue Sep 30 11:24:39 GMT 2025

- 2.7K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial001_py39.py

from fastapi import FastAPI, WebSocket
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">
            <input type="text" id="messageText" autocomplete="off"/>
            <button>Send</button>
        </form>
        <ul id='messages'>

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 17 20:41:43 GMT 2025

- 1.4K bytes

- Click Count (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_static_files/test_tutorial001.py

import os
from pathlib import Path

import pytest
from fastapi.testclient import TestClient


@pytest.fixture(scope="module")
def client():
    static_dir: Path = Path(os.getcwd()) / "static"
    static_dir.mkdir(exist_ok=True)
    sample_file = static_dir / "sample.txt"
    sample_file.write_text("This is a sample static file.")
    from docs_src.static_files.tutorial001_py39 import app

    with TestClient(app) as client:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Fri Dec 26 10:43:02 GMT 2025

- 1.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

fastapi/openapi/utils.py

    get_validation_alias,
)
from fastapi.encoders import jsonable_encoder
from fastapi.exceptions import FastAPIDeprecationWarning
from fastapi.openapi.constants import METHODS_WITH_BODY, REF_PREFIX
from fastapi.openapi.models import OpenAPI
from fastapi.params import Body, ParamTypes
from fastapi.responses import Response
from fastapi.types import ModelNameMap
from fastapi.utils import (
    deep_dict_update,

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sat Dec 27 12:54:56 GMT 2025

- 23.2K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/pt/docs/tutorial/header-param-models.md

Isso é possível desde a versão `0.115.0` do FastAPI. 🤓

///

## Parâmetros do Cabeçalho com um Modelo Pydantic { #header-parameters-with-a-pydantic-model }

Declare os **parâmetros de cabeçalho** que você precisa em um **modelo do Pydantic**, e então declare o parâmetro como `Header`:

{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Nov 12 16:23:57 GMT 2025

- 2.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/es/docs/tutorial/header-param-models.md

/// note | Nota

Esto es compatible desde la versión `0.115.0` de FastAPI. 🤓

///

## Parámetros de Header con un Modelo Pydantic { #header-parameters-with-a-pydantic-model }

Declara los **parámetros de header** que necesitas en un **modelo Pydantic**, y luego declara el parámetro como `Header`:

{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Tue Dec 16 16:33:45 GMT 2025

- 2.8K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/advanced/advanced-dependencies.md

这里说的不是类本身（类本就是可调用项），而是类实例。

为此，需要声明 `__call__` 方法：

{* ../../docs_src/dependencies/tutorial011.py hl[10] *}

本例中，**FastAPI**  使用 `__call__` 检查附加参数及子依赖项，稍后，还要调用它向*路径操作函数*传递值。

## 参数化实例

接下来，使用 `__init__` 声明用于**参数化**依赖项的实例参数：

{* ../../docs_src/dependencies/tutorial011.py hl[7] *}

本例中，**FastAPI** 不使用 `__init__`，我们要直接在代码中使用。

## 创建实例

使用以下代码创建类实例：

{* ../../docs_src/dependencies/tutorial011.py hl[16] *}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 1.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/query-param-models.md

如果你有一组具有相关性的**查询参数**，你可以创建一个 **Pydantic 模型**来声明它们。

这将允许你在**多个地方**去**复用模型**，并且一次性为所有参数声明验证和元数据。😎

/// note

FastAPI 从 `0.115.0` 版本开始支持这个特性。🤓

///

## 使用 Pydantic 模型的查询参数

在一个 **Pydantic 模型**中声明你需要的**查询参数**，然后将参数声明为 `Query`：

{* ../../docs_src/query_param_models/tutorial001_an_py310.py hl[9:13,17] *}

**FastAPI** 将会从请求的**查询参数**中**提取**出**每个字段**的数据，并将其提供给你定义的 Pydantic 模型。

## 查看文档

你可以在 `/docs` 页面的 UI 中查看查询参数：

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Tue Nov 26 22:06:31 GMT 2024

- 2K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ja/docs/tutorial/path-operation-configuration.md

また、`from starlette import status`を使用することもできます。

**FastAPI** は開発者の利便性を考慮して、`fastapi.status`と同じ`starlette.status`を提供しています。しかし、これはStarletteから直接提供されています。

///

## タグ

`tags`パラメータを`str`の`list`（通常は１つの`str`）と一緒に渡すと、*path operation*にタグを追加できます:

{* ../../docs_src/path_operation_configuration/tutorial002.py hl[17,22,27] *}

これらはOpenAPIスキーマに追加され、自動ドキュメントのインターフェースで使用されます:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 4.2K bytes

- Click Count (0)

Search Options