prefect.server.api.server
¶
Defines the Prefect REST API FastAPI app.
RequestLimitMiddleware
¶
A middleware that limits the number of concurrent requests handled by the API.
This is a blunt tool for limiting SQLite concurrent writes which will cause failures at high volume. Ideally, we would only apply the limit to routes that perform writes.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
|
SPAStaticFiles
¶
Bases: StaticFiles
Implementation of StaticFiles
for serving single page applications.
Adds get_response
handling to ensure that when a resource isn't found the
application still returns the index.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
create_api_app
¶
Create a FastAPI app that includes the Prefect REST API
Parameters:
Name | Type | Description | Default |
---|---|---|---|
router_prefix |
Optional[str]
|
a prefix to apply to all included routers |
''
|
dependencies |
Optional[List[Depends]]
|
a list of global dependencies to add to each Prefect REST API router |
None
|
health_check_path |
str
|
the health check route path |
'/health'
|
fast_api_app_kwargs |
dict
|
kwargs to pass to the FastAPI constructor |
None
|
router_overrides |
Mapping[str, Optional[APIRouter]]
|
a mapping of route prefixes (i.e. "/admin") to new routers
allowing the caller to override the default routers. If |
None
|
Returns:
Type | Description |
---|---|
FastAPI
|
a FastAPI app that serves the Prefect REST API |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
|
create_app
¶
Create an FastAPI app that includes the Prefect REST API and UI
Parameters:
Name | Type | Description | Default |
---|---|---|---|
settings |
Settings
|
The settings to use to create the app. If not set, settings are pulled from the context. |
None
|
ignore_cache |
bool
|
If set, a new application will be created even if the settings match. Otherwise, an application is returned from the cache. |
False
|
ephemeral |
bool
|
If set, the application will be treated as ephemeral. The UI and services will be disabled. |
False
|
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
|
custom_internal_exception_handler
async
¶
Log a detailed exception for internal server errors before returning.
Send 503 for errors clients can retry on.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
integrity_exception_handler
async
¶
Capture database integrity errors.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
140 141 142 143 144 145 146 147 148 149 150 151 152 |
|
prefect_object_not_found_exception_handler
async
¶
Return 404 status code on object not found exceptions.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
204 205 206 207 208 209 210 |
|
validation_exception_handler
async
¶
Provide a detailed message for request validation errors.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/api/server.py
126 127 128 129 130 131 132 133 134 135 136 137 |
|