This commit is contained in:
Alberto Zambrano Zarallo 2026-02-13 18:11:16 +00:00 committed by GitHub
commit 4adefa5a4b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 66 additions and 0 deletions

View File

@ -55,6 +55,32 @@ For example, this model above declares a JSON "`object`" (or Python `dict`) like
}
```
### Required fields that can be `None` { #required-fields-that-can-be-none }
In Python type hints, a parameter can be **required** and still allow the value `None`.
This means that the field must be present in the request body, but its value can be `null`
(`None` in Python).
This typically happens when you use something like `str | None` (or `Optional[str]`) **without** providing a default value.
For example:
{* ../../docs_src/body/tutorial005_py310.py hl[8] *}
In this example:
* The `description` field is **required** (the client must include it in the JSON body).
* Its value can still be `null` (`None` in Python).
* This is different from a truly optional field, which would have a default value:
```python
class Item(BaseModel):
description: str | None = None
```
Here, `description` can be omitted entirely in the request body.
## Declare it as a parameter { #declare-it-as-a-parameter }
To add it to your *path operation*, declare it the same way you declared path and query parameters:

View File

@ -0,0 +1,13 @@
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
description: str
@app.post("/items/")
async def create_item(item: Item):
return item

View File

@ -0,0 +1,27 @@
import importlib
import pytest
from fastapi.testclient import TestClient
@pytest.fixture(
name="client",
params=[
pytest.param("tutorial005_py310"),
],
)
def get_client(request: pytest.FixtureRequest):
mod = importlib.import_module(f"docs_src.body.{request.param}")
client = TestClient(mod.app)
return client
def test_required_nullable_field(client: TestClient):
response = client.post("/items/", json={"description": "Some description"})
assert response.status_code == 200
assert response.json() == {"description": "Some description"}
def test_required_field_missing(client: TestClient):
response = client.post("/items/", json={})
assert response.status_code == 422