Header Parameters¶
🌐 एआई और मनुष्यों द्वारा किया गया अनुवाद
यह अनुवाद मनुष्यों के मार्गदर्शन में एआई द्वारा किया गया है। 🤝
इसमें मूल अर्थ को गलत समझने या अप्राकृतिक लगने आदि जैसी गलतियाँ हो सकती हैं। 🤖
आप हमें एआई LLM को बेहतर मार्गदर्शन करने में मदद करके इस अनुवाद को बेहतर बना सकते हैं।
आप Header parameters को उसी तरह define कर सकते हैं जैसे आप Query, Path और Cookie parameters को define करते हैं।
Header import करें¶
पहले Header import करें:
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}
🤓 Other versions and variants
Tip
Prefer to use the Annotated version if possible.
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}
Header parameters घोषित करें¶
फिर Path, Query और Cookie जैसी ही structure का उपयोग करके header parameters घोषित करें।
आप default value के साथ-साथ सभी अतिरिक्त validation या annotation parameters भी define कर सकते हैं:
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}
🤓 Other versions and variants
Tip
Prefer to use the Annotated version if possible.
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}
तकनीकी विवरण
Header Path, Query और Cookie की एक "sister" class है। यह भी उसी common Param class से inherit करता है।
लेकिन याद रखें कि जब आप fastapi से Query, Path, Header, और अन्य import करते हैं, तो वे वास्तव में functions होते हैं जो special classes return करते हैं।
नोट
headers घोषित करने के लिए, आपको Header का उपयोग करना होगा, क्योंकि अन्यथा parameters को query parameters के रूप में interpret किया जाएगा।
स्वचालित conversion¶
Header में Path, Query और Cookie द्वारा दी जाने वाली functionality के ऊपर थोड़ी अतिरिक्त functionality होती है।
अधिकांश standard headers एक "hyphen" character से अलग किए जाते हैं, जिसे "minus symbol" (-) भी कहा जाता है।
लेकिन Python में user-agent जैसा variable invalid है।
इसलिए, default रूप से, Header headers को extract और document करने के लिए parameter names के characters को underscore (_) से hyphen (-) में convert करेगा।
साथ ही, HTTP headers case-insensitive होते हैं, इसलिए, आप उन्हें standard Python style (जिसे "snake_case" भी कहा जाता है) में declare कर सकते हैं।
इसलिए, Python code में सामान्य रूप से जैसे आप user_agent का उपयोग करते हैं, वैसा ही कर सकते हैं, बजाय इसके कि आपको पहले अक्षरों को User_Agent की तरह capitalize करना पड़े या कुछ समान करना पड़े।
अगर किसी कारण से आपको underscores से hyphens में automatic conversion disable करना हो, तो Header के parameter convert_underscores को False पर set करें:
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}
🤓 Other versions and variants
Tip
Prefer to use the Annotated version if possible.
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}
चेतावनी
convert_underscores को False पर set करने से पहले, ध्यान रखें कि कुछ HTTP proxies और servers underscores वाले headers के उपयोग की अनुमति नहीं देते।
Duplicate headers¶
duplicate headers receive करना संभव है। इसका मतलब है, कई values वाला वही header।
आप type declaration में list का उपयोग करके ऐसे cases define कर सकते हैं।
आप duplicate header से सभी values Python list के रूप में receive करेंगे।
उदाहरण के लिए, X-Token का header declare करने के लिए जो एक से अधिक बार आ सकता है, आप लिख सकते हैं:
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}
🤓 Other versions and variants
Tip
Prefer to use the Annotated version if possible.
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}
यदि आप उस path operation के साथ दो HTTP headers भेजते हुए communicate करते हैं, जैसे:
X-Token: foo
X-Token: bar
response ऐसा होगा:
{
"X-Token values": [
"bar",
"foo"
]
}
Recap¶
Query, Path और Cookie जैसे ही common pattern का उपयोग करते हुए, Header के साथ headers declare करें।
और अपनी variables में underscores के बारे में चिंता न करें, FastAPI उन्हें convert करने का ध्यान रखेगा।