read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  c6cffd44_875e_1efd_e4cc_17151353aaae["read_items()"]
  4a3624ac_8d82_f795_0ca8_a428297a7851["tutorial002_py39.py"]
  c6cffd44_875e_1efd_e4cc_17151353aaae -->|defined in| 4a3624ac_8d82_f795_0ca8_a428297a7851
  style c6cffd44_875e_1efd_e4cc_17151353aaae fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial002_py39.py lines 7–11

async def read_items(q: str, item_id: int = Path(title="The ID of the item to get")):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results