read_items() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  06dcd8ba_7d32_025d_7909_a40be6b2ef9d["read_items()"]
  01ada6b5_232b_cb18_78a9_9fc850094337["tutorial010_py39.py"]
  06dcd8ba_7d32_025d_7909_a40be6b2ef9d -->|defined in| 01ada6b5_232b_cb18_78a9_9fc850094337
  style 06dcd8ba_7d32_025d_7909_a40be6b2ef9d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial010_py39.py lines 9–24

async def read_items(
    q: Union[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