cookie - Code Search

docs/zh/docs/tutorial/header-params.md

# Header 参数 { #header-parameters }

定义 `Header` 参数的方式与定义 `Query`、`Path`、`Cookie` 参数相同。

## 导入 `Header` { #import-header }

首先，导入 `Header`：

{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *}

## 声明 `Header` 参数 { #declare-header-parameters }

然后，使用和 `Path`、`Query`、`Cookie` 一样的结构定义 header 参数。

第一个值是默认值，还可以传递所有验证参数或注释参数：

{* ../../docs_src/header_params/tutorial001_an_py310.py hl[9] *}

/// note | 技术细节

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Sun Feb 08 10:39:41 GMT 2026

- 2.6K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/websockets_/tutorial002_py310.py

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
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)">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Feb 27 12:34:37 GMT 2026

- 2.7K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/websockets_/tutorial002_an_py310.py

from typing import Annotated

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
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)">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Feb 27 12:34:37 GMT 2026

- 2.8K bytes

- Click Count (0)

github.com/tiangolo/fastapi

fastapi/security/api_key.py

class APIKeyCookie(APIKeyBase):
    """
    API key authentication using a cookie.

    This defines the name of the cookie that should be provided in the request with
    the API key and integrates that into the OpenAPI documentation. It extracts
    the key value sent in the cookie automatically and provides it as the dependency
    result. But it doesn't define how to set that cookie.

    ## Usage

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Sun Mar 15 11:44:39 GMT 2026

- 9.6K bytes

- Click Count (1)

github.com/tiangolo/fastapi

tests/test_security_api_key_cookie_description.py

                "securitySchemes": {
                    "APIKeyCookie": {
                        "type": "apiKey",
                        "name": "key",
                        "in": "cookie",
                        "description": "An API Cookie Key",
                    }
                }
            },
        }

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Sun Feb 08 10:18:38 GMT 2026

- 2.3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/response_cookies/tutorial002_py310.py

from fastapi import FastAPI, Response

app = FastAPI()


@app.post("/cookie-and-object/")
def create_cookie(response: Response):
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 272 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/cookie_param_models/tutorial002_py310.py

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    model_config = {"extra": "forbid"}

    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Cookies = Cookie()):

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Tue Sep 17 18:54:10 GMT 2024

- 343 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/cookie_param_models/tutorial001_an_py310.py

from typing import Annotated

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Annotated[Cookies, Cookie()]):

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Tue Sep 17 18:54:10 GMT 2024

- 343 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/advanced/response-cookies.md

# 响应Cookies { #response-cookies }

## 使用 `Response` 参数 { #use-a-response-parameter }

你可以在 *路径操作函数* 中定义一个类型为 `Response` 的参数，这样你就可以在这个临时响应对象中设置cookie了。

{* ../../docs_src/response_cookies/tutorial002_py310.py hl[1, 8:9] *}

而且你还可以根据你的需要响应不同的对象，比如常用的 `dict`，数据库model等。

如果你定义了 `response_model`，程序会自动根据`response_model`来过滤和转换你响应的对象。

**FastAPI** 会使用这个 *临时* 响应对象去装在这些cookies信息 (同样还有headers和状态码等信息), 最终会将这些信息和通过`response_model`转化过的数据合并到最终的响应里。

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:06:37 GMT 2026

- 2.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ja/docs/tutorial/header-params.md

# ヘッダーのパラメータ { #header-parameters }

ヘッダーのパラメータは、`Query`や`Path`、`Cookie`のパラメータを定義するのと同じように定義できます。

## `Header`をインポート { #import-header }

まず、`Header`をインポートします:

{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *}

## `Header`のパラメータの宣言 { #declare-header-parameters }

次に、`Path`や`Query`、`Cookie`と同じ構造を用いてヘッダーのパラメータを宣言します。

デフォルト値に加えて、追加の検証パラメータや注釈パラメータをすべて定義できます:

{* ../../docs_src/header_params/tutorial001_an_py310.py hl[9] *}

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Wed Feb 04 16:44:21 GMT 2026

- 3.9K bytes

- Click Count (0)

Search Options