docs_src/schema_extra_example/tutorial002.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str = Field(example="Foo")
    description: Union[str, None] = Field(default=None, example="A very nice Item")
    price: float = Field(example=35.4)
    tax: Union[float, None] = Field(default=None, example=3.2)


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    results = {"item_id": item_id, "item": item}
    return results
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`from typing import Union`
📝 Use Optional in docs (#1644) * Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com> 2020-06-28 20:13:30 +02:00
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00			`from fastapi import FastAPI`
			`from pydantic import BaseModel, Field`

			`app = FastAPI()`


			`class Item(BaseModel):`
✨ Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) * ✨ Do not require default value in Query(), Path(), Header(), etc * 📝 Update source examples for docs with default and required values * ✅ Update tests with new default values and not required Ellipsis * 📝 Update docs for Query params and update info about default value, required, Ellipsis 2022-05-13 18:38:22 -05:00			`name: str = Field(example="Foo")`
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`description: Union[str, None] = Field(default=None, example="A very nice Item")`
✨ Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) * ✨ Do not require default value in Query(), Path(), Header(), etc * 📝 Update source examples for docs with default and required values * ✅ Update tests with new default values and not required Ellipsis * 📝 Update docs for Query params and update info about default value, required, Ellipsis 2022-05-13 18:38:22 -05:00			`price: float = Field(example=35.4)`
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`tax: Union[float, None] = Field(default=None, example=3.2)`
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00

			`@app.put("/items/{item_id}")`
📝 Remove , from functions where it's not needed #1234 (#1239) Fix for - [FEATURE] Remove , where it's not needed #1234 🔥 Remove unnecessary arg , 🎨 Update docs format highlight lines Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-06-13 01:11:44 +05:30			`async def update_item(item_id: int, item: Item):`
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00			`results = {"item_id": item_id, "item": item}`
			`return results`