mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-23 22:29:34 -05:00
1b714b3177
* ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict * ✨ Add support for openapi_examples in parameters * 📝 Add new docs examples for new parameter openapi_examples * 📝 Update docs for Schema Extra to include OpenAPI examples * ✅ Add tests for new source examples, for openapi_examples * ✅ Add tests for openapi_examples corner cases and all parameters * 💡 Tweak and ignore type annotation checks for custom TypedDict
50 lines
1.3 KiB
Python
50 lines
1.3 KiB
Python
from fastapi import Body, FastAPI
|
|
from pydantic import BaseModel
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class Item(BaseModel):
|
|
name: str
|
|
description: str | None = None
|
|
price: float
|
|
tax: float | None = None
|
|
|
|
|
|
@app.put("/items/{item_id}")
|
|
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
|