read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  5736ee0c_7fe6_5c64_11ad_0ed7b3fbb78e["read_items()"]
  943cba9a_c5e8_591e_34d6_2af3c4c53151["tutorial009_py39.py"]
  5736ee0c_7fe6_5c64_11ad_0ed7b3fbb78e -->|defined in| 943cba9a_c5e8_591e_34d6_2af3c4c53151
  style 5736ee0c_7fe6_5c64_11ad_0ed7b3fbb78e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial009_py39.py lines 9–13

async def read_items(q: Union[str, None] = Query(default=None, alias="item-query")):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results