read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  78d3b73a_c5d6_091d_536b_acd8eb1bc614["read_items()"]
  3bd71abc_dec2_5d2f_6394_b9d7768bf745["tutorial010_py310.py"]
  78d3b73a_c5d6_091d_536b_acd8eb1bc614 -->|defined in| 3bd71abc_dec2_5d2f_6394_b9d7768bf745
  style 78d3b73a_c5d6_091d_536b_acd8eb1bc614 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial010_py310.py lines 7–22

async def read_items(
    q: str | None = Query(
        default=None,
        alias="item-query",
        title="Query string",
        description="Query string for the items to search in the database that have a good match",
        min_length=3,
        max_length=50,
        pattern="^fixedquery$",
        deprecated=True,
    ),
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results