read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  9904ca35_d098_7a0a_b97a_6620467154c6["read_items()"]
  8f80dfc3_fa96_a474_681f_a064ae2f6fd8["tutorial008_an_py39.py"]
  9904ca35_d098_7a0a_b97a_6620467154c6 -->|defined in| 8f80dfc3_fa96_a474_681f_a064ae2f6fd8
  style 9904ca35_d098_7a0a_b97a_6620467154c6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial008_an_py39.py lines 9–22

async def read_items(
    q: Annotated[
        Union[str, None],
        Query(
            title="Query string",
            description="Query string for the items to search in the database that have a good match",
            min_length=3,
        ),
    ] = None,
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results