library/docs-fastapi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync fastapi docs from 11614be9 on 2026-03-11

Browse Source
This commit is contained in:
The Librarian
2026-03-11 04:00:06 +00:00
parent 95d1a394e6
commit 18a95756ed
1722 changed files with 91405 additions and 23556 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs_src/query_params_str_validations/tutorial001_py39.py
-13
View File
@@ -1,13 +0,0 @@
from typing import Union
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(q: Union[str, None] = None):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial002_an_py39.py
-13
View File
@@ -1,13 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Annotated[Union[str, None], Query(max_length=50)] = None):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial002_py39.py
-13
View File
@@ -1,13 +0,0 @@
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, max_length=50)):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial003_an_py39.py
-15
View File
@@ -1,15 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[Union[str, None], Query(min_length=3, max_length=50)] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial003_py39.py
-15
View File
@@ -1,15 +0,0 @@
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, min_length=3, max_length=50),
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial004_an_py39.py
-17
View File
@@ -1,17 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[
Union[str, None], Query(min_length=3, max_length=50, pattern="^fixedquery$")
] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial004_py39.py
-17
View File
@@ -1,17 +0,0 @@
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, min_length=3, max_length=50, pattern="^fixedquery$"
),
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial004_regex_an_py310.py
-17
View File
@@ -1,17 +0,0 @@
from typing import Annotated
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[
str | None, Query(min_length=3, max_length=50, regex="^fixedquery$")
] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial005_an_py39.py → docs_src/query_params_str_validations/tutorial005_an_py310.py
View File
docs_src/query_params_str_validations/tutorial005_py39.py → docs_src/query_params_str_validations/tutorial005_py310.py
View File
docs_src/query_params_str_validations/tutorial006_an_py39.py → docs_src/query_params_str_validations/tutorial006_an_py310.py
View File
docs_src/query_params_str_validations/tutorial006_py39.py → docs_src/query_params_str_validations/tutorial006_py310.py
View File
docs_src/query_params_str_validations/tutorial006c_an_py39.py
-13
View File
@@ -1,13 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Annotated[Union[str, None], Query(min_length=3)]):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial006c_py39.py
-13
View File
@@ -1,13 +0,0 @@
from typing import Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Union[str, None] = Query(min_length=3)):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial007_an_py39.py
-15
View File
@@ -1,15 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[Union[str, None], Query(title="Query string", min_length=3)] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial007_py39.py
-15
View File
@@ -1,15 +0,0 @@
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", min_length=3),
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial008_an_py39.py
-22
View File
@@ -1,22 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[
Union[str, None],
Query(
title="Query string",
description="Query string for the items to search in the database that have a good match",
min_length=3,
),
] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial008_py39.py
-20
View File
@@ -1,20 +0,0 @@
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
docs_src/query_params_str_validations/tutorial009_an_py39.py
-13
View File
@@ -1,13 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Annotated[Union[str, None], Query(alias="item-query")] = None):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial009_py39.py
-13
View File
@@ -1,13 +0,0 @@
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, alias="item-query")):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial010_an_py39.py
-26
View File
@@ -1,26 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
q: Annotated[
Union[str, None],
Query(
alias="item-query",
title="Query string",
description="Query string for the items to search in the database that have a good match",
min_length=3,
max_length=50,
pattern="^fixedquery$",
deprecated=True,
),
] = None,
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial010_py39.py
-24
View File
@@ -1,24 +0,0 @@
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,
alias="item-query",
title="Query string",
description="Query string for the items to search in the database that have a good match",
min_length=3,
max_length=50,
pattern="^fixedquery$",
deprecated=True,
),
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
docs_src/query_params_str_validations/tutorial011_an_py39.py
-11
View File
@@ -1,11 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Annotated[Union[list[str], None], Query()] = None):
query_items = {"q": q}
return query_items
docs_src/query_params_str_validations/tutorial011_py39.py
-11
View File
@@ -1,11 +0,0 @@
from typing import Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(q: Union[list[str], None] = Query(default=None)):
query_items = {"q": q}
return query_items
docs_src/query_params_str_validations/tutorial012_an_py39.py → docs_src/query_params_str_validations/tutorial012_an_py310.py
View File
docs_src/query_params_str_validations/tutorial012_py39.py → docs_src/query_params_str_validations/tutorial012_py310.py
View File
docs_src/query_params_str_validations/tutorial013_an_py39.py → docs_src/query_params_str_validations/tutorial013_an_py310.py
View File
docs_src/query_params_str_validations/tutorial013_py39.py → docs_src/query_params_str_validations/tutorial013_py310.py
View File
docs_src/query_params_str_validations/tutorial014_an_py39.py
-15
View File
@@ -1,15 +0,0 @@
from typing import Annotated, Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
hidden_query: Annotated[Union[str, None], Query(include_in_schema=False)] = None,
):
if hidden_query:
return {"hidden_query": hidden_query}
else:
return {"hidden_query": "Not found"}
docs_src/query_params_str_validations/tutorial014_py39.py
-15
View File
@@ -1,15 +0,0 @@
from typing import Union
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(
hidden_query: Union[str, None] = Query(default=None, include_in_schema=False),
):
if hidden_query:
return {"hidden_query": hidden_query}
else:
return {"hidden_query": "Not found"}
docs_src/query_params_str_validations/tutorial015_an_py39.py
-30
View File
@@ -1,30 +0,0 @@
import random
from typing import Annotated, Union
from fastapi import FastAPI
from pydantic import AfterValidator
app = FastAPI()
data = {
"isbn-9781529046137": "The Hitchhiker's Guide to the Galaxy",
"imdb-tt0371724": "The Hitchhiker's Guide to the Galaxy",
"isbn-9781439512982": "Isaac Asimov: The Complete Stories, Vol. 2",
}
def check_valid_id(id: str):
if not id.startswith(("isbn-", "imdb-")):
raise ValueError('Invalid ID format, it must start with "isbn-" or "imdb-"')
return id
@app.get("/items/")
async def read_items(
id: Annotated[Union[str, None], AfterValidator(check_valid_id)] = None,
):
if id:
item = data.get(id)
else:
id, item = random.choice(list(data.items()))
return {"id": id, "name": item}