read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  201000f9_74b1_b06a_17bb_4e1f15650ccb["read_items()"]
  b7443521_4245_d0d4_a0cd_7efa48fea36e["tutorial001_py39.py"]
  201000f9_74b1_b06a_17bb_4e1f15650ccb -->|defined in| b7443521_4245_d0d4_a0cd_7efa48fea36e
  style 201000f9_74b1_b06a_17bb_4e1f15650ccb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial001_py39.py lines 9–16

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