read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  434c2a26_e9ab_6c06_3824_d3a546b47f21["read_items()"]
  99569061_3034_4d28_9cfb_8822c4927bf4["tutorial010_an_py39.py"]
  434c2a26_e9ab_6c06_3824_d3a546b47f21 -->|defined in| 99569061_3034_4d28_9cfb_8822c4927bf4
  style 434c2a26_e9ab_6c06_3824_d3a546b47f21 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial010_an_py39.py lines 9–26

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