Response 類別

您可以在*路徑操作函式*或依賴項中宣告一個類型為 Response 的參數，然後您可以設定回應的資料，例如標頭或 Cookie。

您也可以直接使用它來建立它的實例，並從您的*路徑操作*中返回它。

您可以直接從 fastapi 導入它

from fastapi import Response

fastapi.Response

Response(
    content=None,
    status_code=200,
    headers=None,
    media_type=None,
    background=None,
)

參數	說明
content	類型： Any 預設值： None
status_code	類型： int 預設值： 200
headers	類型： Mapping[str, str] | None 預設值： None
media_type	類型： str | None 預設值： None
background	類型： BackgroundTask | None 預設值： None

原始碼位於 starlette/responses.py

def __init__(
    self,
    content: typing.Any = None,
    status_code: int = 200,
    headers: typing.Mapping[str, str] | None = None,
    media_type: str | None = None,
    background: BackgroundTask | None = None,
) -> None:
    self.status_code = status_code
    if media_type is not None:
        self.media_type = media_type
    self.background = background
    self.body = self.render(content)
    self.init_headers(headers)

media_type 類別屬性 實例屬性

media_type = None

charset 類別屬性 實例屬性

charset = 'utf-8'

status_code 實例屬性

status_code = status_code

background 實例屬性

background = background

body 實例屬性

body = render(content)

headers 屬性

headers

render

render(content)

參數	說明
content	類型： Any

原始碼位於 starlette/responses.py

def render(self, content: typing.Any) -> bytes | memoryview:
    if content is None:
        return b""
    if isinstance(content, (bytes, memoryview)):
        return content
    return content.encode(self.charset)  # type: ignore

init_headers

init_headers(headers=None)

參數	說明
headers	類型： Mapping[str, str] | None 預設值： None

原始碼位於 starlette/responses.py

def init_headers(self, headers: typing.Mapping[str, str] | None = None) -> None:
    if headers is None:
        raw_headers: list[tuple[bytes, bytes]] = []
        populate_content_length = True
        populate_content_type = True
    else:
        raw_headers = [(k.lower().encode("latin-1"), v.encode("latin-1")) for k, v in headers.items()]
        keys = [h[0] for h in raw_headers]
        populate_content_length = b"content-length" not in keys
        populate_content_type = b"content-type" not in keys

    body = getattr(self, "body", None)
    if (
        body is not None
        and populate_content_length
        and not (self.status_code < 200 or self.status_code in (204, 304))
    ):
        content_length = str(len(body))
        raw_headers.append((b"content-length", content_length.encode("latin-1")))

    content_type = self.media_type
    if content_type is not None and populate_content_type:
        if content_type.startswith("text/") and "charset=" not in content_type.lower():
            content_type += "; charset=" + self.charset
        raw_headers.append((b"content-type", content_type.encode("latin-1")))

    self.raw_headers = raw_headers

set_cookie

set_cookie(
    key,
    value="",
    max_age=None,
    expires=None,
    path="/",
    domain=None,
    secure=False,
    httponly=False,
    samesite="lax",
)

參數	說明
鍵值 (key)	類型： str
值 (value)	類型： str 預設值： ''
最大存活時間 (max_age)	類型： int | None 預設值： None
到期時間 (expires)	類型： datetime | str | int | None 預設值： None
路徑 (path)	類型： str | None 預設值： '/'
網域 (domain)	類型： str | None 預設值： None
安全連線 (secure)	類型： bool 預設值： False
僅限 HTTP (httponly)	類型： bool 預設值： False
SameSite 屬性 (samesite)	類型： Literal['lax', 'strict', 'none'] | None 預設值： 'lax'

原始碼位於 starlette/responses.py

def set_cookie(
    self,
    key: str,
    value: str = "",
    max_age: int | None = None,
    expires: datetime | str | int | None = None,
    path: str | None = "/",
    domain: str | None = None,
    secure: bool = False,
    httponly: bool = False,
    samesite: typing.Literal["lax", "strict", "none"] | None = "lax",
) -> None:
    cookie: http.cookies.BaseCookie[str] = http.cookies.SimpleCookie()
    cookie[key] = value
    if max_age is not None:
        cookie[key]["max-age"] = max_age
    if expires is not None:
        if isinstance(expires, datetime):
            cookie[key]["expires"] = format_datetime(expires, usegmt=True)
        else:
            cookie[key]["expires"] = expires
    if path is not None:
        cookie[key]["path"] = path
    if domain is not None:
        cookie[key]["domain"] = domain
    if secure:
        cookie[key]["secure"] = True
    if httponly:
        cookie[key]["httponly"] = True
    if samesite is not None:
        assert samesite.lower() in [
            "strict",
            "lax",
            "none",
        ], "samesite must be either 'strict', 'lax' or 'none'"
        cookie[key]["samesite"] = samesite
    cookie_val = cookie.output(header="").strip()
    self.raw_headers.append((b"set-cookie", cookie_val.encode("latin-1")))

delete_cookie

delete_cookie(
    key,
    path="/",
    domain=None,
    secure=False,
    httponly=False,
    samesite="lax",
)

參數	說明
鍵值 (key)	類型： str
路徑 (path)	類型： str 預設值： '/'
網域 (domain)	類型： str | None 預設值： None
安全連線 (secure)	類型： bool 預設值： False
僅限 HTTP (httponly)	類型： bool 預設值： False
SameSite 屬性 (samesite)	類型： Literal['lax', 'strict', 'none'] | None 預設值： 'lax'

原始碼位於 starlette/responses.py

def delete_cookie(
    self,
    key: str,
    path: str = "/",
    domain: str | None = None,
    secure: bool = False,
    httponly: bool = False,
    samesite: typing.Literal["lax", "strict", "none"] | None = "lax",
) -> None:
    self.set_cookie(
        key,
        max_age=0,
        expires=0,
        path=path,
        domain=domain,
        secure=secure,
        httponly=httponly,
        samesite=samesite,
    )