read_item() — fastapi Function Reference

Architecture documentation for the read_item() function in tutorial003_py310.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ read_item() — fastapi Function Reference

Dependency Diagram

graph TD
  2b76076c_35e4_f1ea_6115_5c6984fc6782["read_item()"]
  04df1181_0abf_6e8d_1cd3_26cee01caffb["tutorial003_py310.py"]
  2b76076c_35e4_f1ea_6115_5c6984fc6782 -->|defined in| 04df1181_0abf_6e8d_1cd3_26cee01caffb
  style 2b76076c_35e4_f1ea_6115_5c6984fc6782 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params/tutorial003_py310.py lines 7–15

async def read_item(item_id: str, q: str | None = None, short: bool = False):
    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item