read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  6d131595_e41f_e814_c14c_e99a10960fd4["read_items()"]
  f1391e8e_ef1c_70c8_d428_8353596a131e["tutorial008_an_py310.py"]
  6d131595_e41f_e814_c14c_e99a10960fd4 -->|defined in| f1391e8e_ef1c_70c8_d428_8353596a131e
  style 6d131595_e41f_e814_c14c_e99a10960fd4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial008_an_py310.py lines 9–22

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