Response
class¶
You can declare a parameter in a path operation function or dependency to be of type Response
and then you can set data for the response like headers or cookies.
You can also use it directly to create an instance of it and return it from your path operations.
You can import it directly from fastapi
:
from fastapi import Response
fastapi.Response
¶
Response(
content=None,
status_code=200,
headers=None,
media_type=None,
background=None,
)
PARAMETER | DESCRIPTION |
---|---|
content
|
TYPE:
|
status_code
|
TYPE:
|
headers
|
TYPE:
|
media_type
|
TYPE:
|
background
|
TYPE:
|
Source code in starlette/responses.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
render
¶
render(content)
PARAMETER | DESCRIPTION |
---|---|
content
|
TYPE:
|
Source code in starlette/responses.py
44 45 46 47 48 49 |
|
init_headers
¶
init_headers(headers=None)
PARAMETER | DESCRIPTION |
---|---|
headers
|
TYPE:
|
Source code in starlette/responses.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
|
set_cookie
¶
set_cookie(
key,
value="",
max_age=None,
expires=None,
path="/",
domain=None,
secure=False,
httponly=False,
samesite="lax",
)
PARAMETER | DESCRIPTION |
---|---|
key
|
TYPE:
|
value
|
TYPE:
|
max_age
|
TYPE:
|
expires
|
TYPE:
|
path
|
TYPE:
|
domain
|
TYPE:
|
secure
|
TYPE:
|
httponly
|
TYPE:
|
samesite
|
TYPE:
|
Source code in starlette/responses.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
|
delete_cookie
¶
delete_cookie(
key,
path="/",
domain=None,
secure=False,
httponly=False,
samesite="lax",
)
PARAMETER | DESCRIPTION |
---|---|
key
|
TYPE:
|
path
|
TYPE:
|
domain
|
TYPE:
|
secure
|
TYPE:
|
httponly
|
TYPE:
|
samesite
|
TYPE:
|
Source code in starlette/responses.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|