read_items() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ read_items() — fastapi Function Reference

Dependency Diagram

graph TD
  aac74379_7db8_a586_accd_b7c3cce6ad39["read_items()"]
  d430aa40_b3f9_2d09_db2d_cd307b351faa["tutorial008_py39.py"]
  aac74379_7db8_a586_accd_b7c3cce6ad39 -->|defined in| d430aa40_b3f9_2d09_db2d_cd307b351faa
  style aac74379_7db8_a586_accd_b7c3cce6ad39 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/query_params_str_validations/tutorial008_py39.py lines 9–20

async def read_items(
    q: Union[str, None] = Query(
        default=None,
        title="Query string",
        description="Query string for the items to search in the database that have a good match",
        min_length=3,
    ),
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results