read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  0b3d0332_67be_f9c1_0196_cb631d4b7373["read_items()"]
  31204139_4b11_45c8_661c_58f111bf939b["tutorial004_an_py39.py"]
  0b3d0332_67be_f9c1_0196_cb631d4b7373 -->|defined in| 31204139_4b11_45c8_661c_58f111bf939b
  style 0b3d0332_67be_f9c1_0196_cb631d4b7373 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial004_an_py39.py lines 9–15

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