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

Sync fastapi docs from b5ca1324 on 2025-12-07
Issue Manager / issue-manager (push) Has been cancelled
Details
Build Docs / changes (push) Has been cancelled
Details
Build Docs / langs (push) Has been cancelled
Details
Build Docs / build-docs (push) Has been cancelled
Details
Build Docs / docs-all-green (push) Has been cancelled
Details
Conflict detector / main (push) Has been cancelled
Details
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Details
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Details
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Details
Test / lint (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Details
Test / coverage-combine (push) Has been cancelled
Details
Test / check (push) Has been cancelled
Details
Label Approved / label-approved (push) Has been cancelled
Details
FastAPI People Contributors / job (push) Has been cancelled
Details
FastAPI People Sponsors / job (push) Has been cancelled
Details
Update Topic Repos / topic-repos (push) Has been cancelled
Details
FastAPI People / job (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
The Scheduler
2025-12-07 21:35:20 +00:00
commit a42b1ff04e
2600 changed files with 301870 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs_src/body_updates/tutorial001.py
+34
View File
@@ -0,0 +1,34 @@
from typing import List, Union
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: Union[str, None] = None
description: Union[str, None] = None
price: Union[float, None] = None
tax: float = 10.5
tags: List[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.put("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
update_item_encoded = jsonable_encoder(item)
items[item_id] = update_item_encoded
return update_item_encoded
docs_src/body_updates/tutorial001_py310.py
+32
View File
@@ -0,0 +1,32 @@
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str | None = None
description: str | None = None
price: float | None = None
tax: float = 10.5
tags: list[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.put("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
update_item_encoded = jsonable_encoder(item)
items[item_id] = update_item_encoded
return update_item_encoded
docs_src/body_updates/tutorial001_py39.py
+34
View File
@@ -0,0 +1,34 @@
from typing import Union
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: Union[str, None] = None
description: Union[str, None] = None
price: Union[float, None] = None
tax: float = 10.5
tags: list[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.put("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
update_item_encoded = jsonable_encoder(item)
items[item_id] = update_item_encoded
return update_item_encoded
docs_src/body_updates/tutorial002.py
+37
View File
@@ -0,0 +1,37 @@
from typing import List, Union
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: Union[str, None] = None
description: Union[str, None] = None
price: Union[float, None] = None
tax: float = 10.5
tags: List[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
stored_item_data = items[item_id]
stored_item_model = Item(**stored_item_data)
update_data = item.dict(exclude_unset=True)
updated_item = stored_item_model.copy(update=update_data)
items[item_id] = jsonable_encoder(updated_item)
return updated_item
docs_src/body_updates/tutorial002_py310.py
+35
View File
@@ -0,0 +1,35 @@
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str | None = None
description: str | None = None
price: float | None = None
tax: float = 10.5
tags: list[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
stored_item_data = items[item_id]
stored_item_model = Item(**stored_item_data)
update_data = item.dict(exclude_unset=True)
updated_item = stored_item_model.copy(update=update_data)
items[item_id] = jsonable_encoder(updated_item)
return updated_item
docs_src/body_updates/tutorial002_py39.py
+37
View File
@@ -0,0 +1,37 @@
from typing import Union
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: Union[str, None] = None
description: Union[str, None] = None
price: Union[float, None] = None
tax: float = 10.5
tags: list[str] = []
items = {
"foo": {"name": "Foo", "price": 50.2},
"bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
"baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}
@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
return items[item_id]
@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
stored_item_data = items[item_id]
stored_item_model = Item(**stored_item_data)
update_data = item.dict(exclude_unset=True)
updated_item = stored_item_model.copy(update=update_data)
items[item_id] = jsonable_encoder(updated_item)
return updated_item