read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  6ee14fe1_a092_300a_b6b4_1ccf8713e116["read_items()"]
  8ebe4d54_3077_920f_1966_da97cc78a0bf["tutorial001_an_py310.py"]
  6ee14fe1_a092_300a_b6b4_1ccf8713e116 -->|defined in| 8ebe4d54_3077_920f_1966_da97cc78a0bf
  style 6ee14fe1_a092_300a_b6b4_1ccf8713e116 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial001_an_py310.py lines 9–16

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