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
This commit is contained in:
Sebastián Ramírez
2022-05-13 18:38:22 -05:00
committed by GitHub
parent 31690dda2c
commit 9262fa8362
107 changed files with 404 additions and 314 deletions

View File

@@ -6,5 +6,5 @@ app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Optional[str] = Header(None)):
async def read_items(user_agent: Optional[str] = Header(default=None)):
return {"User-Agent": user_agent}

View File

@@ -4,5 +4,5 @@ app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: str | None = Header(None)):
async def read_items(user_agent: str | None = Header(default=None)):
return {"User-Agent": user_agent}

View File

@@ -7,6 +7,6 @@ app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: Optional[str] = Header(None, convert_underscores=False)
strange_header: Optional[str] = Header(default=None, convert_underscores=False)
):
return {"strange_header": strange_header}

View File

@@ -5,6 +5,6 @@ app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: str | None = Header(None, convert_underscores=False)
strange_header: str | None = Header(default=None, convert_underscores=False)
):
return {"strange_header": strange_header}

View File

@@ -6,5 +6,5 @@ app = FastAPI()
@app.get("/items/")
async def read_items(x_token: Optional[List[str]] = Header(None)):
async def read_items(x_token: Optional[List[str]] = Header(default=None)):
return {"X-Token values": x_token}

View File

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

View File

@@ -6,5 +6,5 @@ app = FastAPI()
@app.get("/items/")
async def read_items(x_token: Optional[list[str]] = Header(None)):
async def read_items(x_token: Optional[list[str]] = Header(default=None)):
return {"X-Token values": x_token}