Request
class¶
You can declare a parameter in a path operation function or dependency to be of type Request
and then you can access the raw request object directly, without any validation, etc.
You can import it directly from fastapi
:
from fastapi import Request
Tip
When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an HTTPConnection
instead of a Request
or a WebSocket
.
fastapi.Request
¶
Request(scope, receive=empty_receive, send=empty_send)
Bases: HTTPConnection
PARAMETER | DESCRIPTION |
---|---|
scope
|
TYPE:
|
receive
|
TYPE:
|
send
|
TYPE:
|
Source code in starlette/requests.py
194 195 196 197 198 199 200 201 |
|
url_for
¶
url_for(name, /, **path_params)
PARAMETER | DESCRIPTION |
---|---|
name
|
TYPE:
|
**path_params
|
TYPE:
|
Source code in starlette/requests.py
177 178 179 180 |
|
stream
async
¶
stream()
Source code in starlette/requests.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
|
body
async
¶
body()
Source code in starlette/requests.py
231 232 233 234 235 236 237 |
|
json
async
¶
json()
Source code in starlette/requests.py
239 240 241 242 243 |
|
form
¶
form(*, max_files=1000, max_fields=1000)
PARAMETER | DESCRIPTION |
---|---|
max_files
|
TYPE:
|
max_fields
|
TYPE:
|
Source code in starlette/requests.py
273 274 275 276 |
|
close
async
¶
close()
Source code in starlette/requests.py
278 279 280 |
|
is_disconnected
async
¶
is_disconnected()
Source code in starlette/requests.py
282 283 284 285 286 287 288 289 290 291 292 293 294 |
|
send_push_promise
async
¶
send_push_promise(path)
PARAMETER | DESCRIPTION |
---|---|
path
|
TYPE:
|
Source code in starlette/requests.py
296 297 298 299 300 301 302 |
|