read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  1e566d71_5422_3bb9_241c_a926ce935b05["read_items()"]
  efa6e480_d235_628a_1eed_f21bb55a723e["tutorial005_py39.py"]
  1e566d71_5422_3bb9_241c_a926ce935b05 -->|defined in| efa6e480_d235_628a_1eed_f21bb55a723e
  style 1e566d71_5422_3bb9_241c_a926ce935b05 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial005_py39.py lines 7–15

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