| 1 |
from typing import Dict, Union |
| 2 |
|
| 3 |
from typing_extensions import Annotated |
| 4 |
|
| 5 |
from litestar import Controller, Litestar, Router, get |
| 6 |
from litestar.params import ( |
| 7 |
CookieParameter, |
| 8 |
FromHeader, |
| 9 |
FromPath, |
| 10 |
FromQuery, |
| 11 |
HeaderParameter, |
| 12 |
QueryParameter, |
| 13 |
) |
| 14 |
|
| 15 |
|
| 16 |
class MyController(Controller): |
| 17 |
path = "/controller" |
| 18 |
parameters = { |
| 19 |
"controller_param": QueryParameter(annotation=int, lt=100), |
| 20 |
} |
| 21 |
|
| 22 |
@get("/{path_param:int}", sync_to_thread=False) |
| 23 |
def my_handler( |
| 24 |
self, |
| 25 |
path_param: FromPath[int], |
| 26 |
local_param: FromQuery[str], |
| 27 |
router_param: FromHeader[str], |
| 28 |
controller_param: Annotated[int, QueryParameter(lt=50)], |
| 29 |
) -> Dict[str, Union[str, int]]: |
| 30 |
return { |
| 31 |
"path_param": path_param, |
| 32 |
"local_param": local_param, |
| 33 |
"router_param": router_param, |
| 34 |
"controller_param": controller_param, |
| 35 |
} |
| 36 |
|
| 37 |
|
| 38 |
router = Router( |
| 39 |
path="/router", |
| 40 |
route_handlers=[MyController], |
| 41 |
parameters={ |
| 42 |
"router_param": HeaderParameter(annotation=str, name="MyHeader", pattern="^[a-zA-Z]$", required=False), |
| 43 |
}, |
| 44 |
) |
| 45 |
|
| 46 |
app = Litestar( |
| 47 |
route_handlers=[router], |
| 48 |
parameters={ |
| 49 |
"app_param": CookieParameter(annotation=str, name="special-cookie", required=False), |
| 50 |
}, |
| 51 |
) |