read_items() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  b05bc71d_0294_39f1_dec7_1cc74ac0c86e["read_items()"]
  385653e6_8e73_0297_683a_221a33c6a532["tutorial010_an_py310.py"]
  b05bc71d_0294_39f1_dec7_1cc74ac0c86e -->|defined in| 385653e6_8e73_0297_683a_221a33c6a532
  style b05bc71d_0294_39f1_dec7_1cc74ac0c86e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial010_an_py310.py lines 9–26

async def read_items(
    q: Annotated[
        str | None,
        Query(
            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,
        ),
    ] = None,
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results