read_items() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  0ff768a9_10ac_a359_9c9f_83d9c81d6b17["read_items()"]
  adb6a730_7cdc_e413_0556_47f68ed008f1["tutorial001_an_py39.py"]
  0ff768a9_10ac_a359_9c9f_83d9c81d6b17 -->|defined in| adb6a730_7cdc_e413_0556_47f68ed008f1
  style 0ff768a9_10ac_a359_9c9f_83d9c81d6b17 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial001_an_py39.py lines 9–16

async def read_items(
    item_id: Annotated[int, Path(title="The ID of the item to get")],
    q: Annotated[Union[str, None], Query(alias="item-query")] = None,
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results