read_items() — fastapi Function Reference

Architecture documentation for the read_items() function in tutorial005_an_py39.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  fbb73ac4_1ea7_6492_8c35_c941244a9ca0["read_items()"]
  944aaa32_1917_699b_846c_f6241a0f4578["tutorial005_an_py39.py"]
  fbb73ac4_1ea7_6492_8c35_c941244a9ca0 -->|defined in| 944aaa32_1917_699b_846c_f6241a0f4578
  style fbb73ac4_1ea7_6492_8c35_c941244a9ca0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial005_an_py39.py lines 9–16

async def read_items(
    item_id: Annotated[int, Path(title="The ID of the item to get", gt=0, le=1000)],
    q: str,
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results