Sync fastapi docs from b5ca1324 on 2025-12-07

docs_src/header_params/tutorial001.py

@@ -0,0 +1,10 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(user_agent: Union[str, None] = Header(default=None)):
+    return {"User-Agent": user_agent}

docs_src/header_params/tutorial001_an.py

@@ -0,0 +1,11 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+from typing_extensions import Annotated
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
+    return {"User-Agent": user_agent}

docs_src/header_params/tutorial001_an_py310.py

@@ -0,0 +1,10 @@
+from typing import Annotated
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(user_agent: Annotated[str | None, Header()] = None):
+    return {"User-Agent": user_agent}

docs_src/header_params/tutorial001_an_py39.py

@@ -0,0 +1,10 @@
+from typing import Annotated, Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
+    return {"User-Agent": user_agent}

docs_src/header_params/tutorial001_py310.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(user_agent: str | None = Header(default=None)):
+    return {"User-Agent": user_agent}

docs_src/header_params/tutorial002.py

@@ -0,0 +1,12 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(
+    strange_header: Union[str, None] = Header(default=None, convert_underscores=False),
+):
+    return {"strange_header": strange_header}

docs_src/header_params/tutorial002_an.py

@@ -0,0 +1,15 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+from typing_extensions import Annotated
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(
+    strange_header: Annotated[
+        Union[str, None], Header(convert_underscores=False)
+    ] = None,
+):
+    return {"strange_header": strange_header}

docs_src/header_params/tutorial002_an_py310.py

@@ -0,0 +1,12 @@
+from typing import Annotated
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(
+    strange_header: Annotated[str | None, Header(convert_underscores=False)] = None,
+):
+    return {"strange_header": strange_header}

docs_src/header_params/tutorial002_an_py39.py

@@ -0,0 +1,14 @@
+from typing import Annotated, Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(
+    strange_header: Annotated[
+        Union[str, None], Header(convert_underscores=False)
+    ] = None,
+):
+    return {"strange_header": strange_header}

docs_src/header_params/tutorial002_py310.py

@@ -0,0 +1,10 @@
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(
+    strange_header: str | None = Header(default=None, convert_underscores=False),
+):
+    return {"strange_header": strange_header}

docs_src/header_params/tutorial003.py

@@ -0,0 +1,10 @@
+from typing import List, Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: Union[List[str], None] = Header(default=None)):
+    return {"X-Token values": x_token}

docs_src/header_params/tutorial003_an.py

@@ -0,0 +1,11 @@
+from typing import List, Union
+
+from fastapi import FastAPI, Header
+from typing_extensions import Annotated
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: Annotated[Union[List[str], None], Header()] = None):
+    return {"X-Token values": x_token}

docs_src/header_params/tutorial003_an_py310.py

@@ -0,0 +1,10 @@
+from typing import Annotated
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: Annotated[list[str] | None, Header()] = None):
+    return {"X-Token values": x_token}

docs_src/header_params/tutorial003_an_py39.py

@@ -0,0 +1,10 @@
+from typing import Annotated, List, Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: Annotated[Union[List[str], None], Header()] = None):
+    return {"X-Token values": x_token}

docs_src/header_params/tutorial003_py310.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: list[str] | None = Header(default=None)):
+    return {"X-Token values": x_token}

docs_src/header_params/tutorial003_py39.py

@@ -0,0 +1,10 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+
+app = FastAPI()
+
+
+@app.get("/items/")
+async def read_items(x_token: Union[list[str], None] = Header(default=None)):
+    return {"X-Token values": x_token}