COOKIE - Code Search

tests/test_tutorial/test_cookie_param_models/test_tutorial001.py

                                "in": "cookie",
                                "required": True,
                                "schema": {"type": "string", "title": "Session Id"},
                            },
                            {
                                "name": "fatebook_tracker",
                                "in": "cookie",
                                "required": False,

Registered: Sun Nov 03 07:19:11 UTC 2024

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

- 7.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

# Header Parameters

You can define Header parameters the same way you define `Query`, `Path` and `Cookie` parameters.

## Import `Header`

First import `Header`:

//// tab | Python 3.10+

```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001_an_py310.py!}
```

////

//// tab | Python 3.9+

```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001_an_py39.py!}
```

////

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 5.6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/cookie_param_models/tutorial002_pv1_an_py39.py

from typing import Annotated, Union

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    class Config:
        extra = "forbid"

    session_id: str
    fatebook_tracker: Union[str, None] = None
    googall_tracker: Union[str, None] = None


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

Registered: Sun Nov 03 07:19:11 UTC 2024

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

- 406 bytes

- Viewed (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

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Tue Apr 23 22:29:18 UTC 2024

- 9.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/cookie_param_models/tutorial002_pv1_an.py

from fastapi import Cookie, FastAPI
from pydantic import BaseModel
from typing_extensions import Annotated

app = FastAPI()


class Cookies(BaseModel):
    class Config:
        extra = "forbid"

    session_id: str
    fatebook_tracker: Union[str, None] = None
    googall_tracker: Union[str, None] = None


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

Registered: Sun Nov 03 07:19:11 UTC 2024

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

- 435 bytes

- Viewed (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)">

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.8K bytes

- Viewed (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)">

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_an.py

from typing import Union

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse
from typing_extensions import Annotated

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_an_py39.py

from typing import Annotated, Union

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)">

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

# 헤더 매개변수

헤더 매개변수를 `Query`, `Path` 그리고 `Cookie` 매개변수들과 같은 방식으로 정의할 수 있습니다.

## `Header` 임포트

먼저 `Header`를 임포트합니다:

```Python hl_lines="3"
{!../../docs_src/header_params/tutorial001.py!}
```

## `Header` 매개변수 선언

`Path`, `Query` 그리고 `Cookie`를 사용한 동일한 구조를 이용하여 헤더 매개변수를 선언합니다.

첫 번째 값은 기본값이며, 추가 검증이나 어노테이션 매개변수 모두 전달할 수 있습니다:

```Python hl_lines="9"
{!../../docs_src/header_params/tutorial001.py!}
```

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 3.3K bytes

- Viewed (0)

Search Options