docs_src/query_params_str_validations/tutorial008.py

from typing import Union

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
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
✨ 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			`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 Query() parameters tutorial and update docs 2018-12-14 17:10:08 +04:00			`from fastapi import FastAPI, Query`

			`app = FastAPI()`


			`@app.get("/items/")`
			`async def read_items(`
✨ 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			`q: Union[str, None] = Query(`
			`default=None,`
:memo: Add Query() parameters tutorial and update docs 2018-12-14 17:10:08 +04:00			`title="Query string",`
			`description="Query string for the items to search in the database that have a good match",`
			`min_length=3,`
👷 Adopt Ruff format (#10517) * 🔧 Update pre-commit, use ruff format * ⬆️ Upgrade dependencies, use Ruff for formatting * 🔧 Update Ruff config * 🔨 Update lint and format scripts, use Ruff * 🎨 Format internals with Ruff * 🎨 Format docs scripts * 🎨 Format tests * 🎨 Format extra commas in src for docs * 📝 Update docs mentioning `@lru_cache()`, use `@lru_cache` instead to keep consistency with the format * 🎨 Update src for docs, use plain `@lru_cache` * 🎨 Update src for docs format and docs references 2023-10-25 00:26:06 +04:00			`),`
:memo: Add Query() parameters tutorial and update docs 2018-12-14 17:10:08 +04:00			`):`
			`results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}`
			`if q:`
			`results.update({"q": q})`
			`return results`