read_items() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ read_items() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

docs_src/path_params_numeric_validations/tutorial004_py39.py lines 7–13

async def read_items(
    *, item_id: 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