read_item() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_item() — fastapi Function Reference

Dependency Diagram

graph TD
  69892d7e_8bc3_0ac1_d91f_a48b4f0e49a2["read_item()"]
  163382a0_65f6_e221_baf5_eab1d640ec40["tutorial003_py39.py"]
  69892d7e_8bc3_0ac1_d91f_a48b4f0e49a2 -->|defined in| 163382a0_65f6_e221_baf5_eab1d640ec40
  style 69892d7e_8bc3_0ac1_d91f_a48b4f0e49a2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params/tutorial003_py39.py lines 9–17

async def read_item(item_id: str, q: Union[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