update_item() — fastapi Function Reference

Architecture documentation for the update_item() function in tutorial005_py310.py from the fastapi codebase.

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ update_item() — fastapi Function Reference

Dependency Diagram

graph TD
  15127a14_984b_05e1_9b06_5c76ecd87e29["update_item()"]
  fc1b407f_bb6f_1632_89ae_8d73c4c8e29c["tutorial005_py310.py"]
  15127a14_984b_05e1_9b06_5c76ecd87e29 -->|defined in| fc1b407f_bb6f_1632_89ae_8d73c4c8e29c
  style 15127a14_984b_05e1_9b06_5c76ecd87e29 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/schema_extra_example/tutorial005_py310.py lines 15–49

async def update_item(
    *,
    item_id: int,
    item: Item = Body(
        openapi_examples={
            "normal": {
                "summary": "A normal example",
                "description": "A **normal** item works correctly.",
                "value": {
                    "name": "Foo",
                    "description": "A very nice Item",
                    "price": 35.4,
                    "tax": 3.2,
                },
            },
            "converted": {
                "summary": "An example with converted data",
                "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
                "value": {
                    "name": "Bar",
                    "price": "35.4",
                },
            },
            "invalid": {
                "summary": "Invalid data is rejected with an error",
                "value": {
                    "name": "Baz",
                    "price": "thirty five point four",
                },
            },
        },
    ),
):
    results = {"item_id": item_id, "item": item}
    return results