Response Status Code¶

जिस तरह आप response model specify कर सकते हैं, उसी तरह आप किसी भी path operations में parameter status_code के साथ response के लिए इस्तेमाल किया जाने वाला HTTP status code भी declare कर सकते हैं:

• @app.get()
• @app.post()
• @app.put()
• @app.delete()
• आदि।

from fastapi import FastAPI

app = FastAPI()


@app.post("/items/", status_code=201)
async def create_item(name: str):
    return {"name": name}

status_code parameter HTTP status code वाला एक number receive करता है।

यह:

• response में वह status code return करेगा।
• उसे OpenAPI schema में उसी तरह document करेगा (और इसलिए, user interfaces में भी):

HTTP status codes के बारे में¶

HTTP में, आप response के हिस्से के रूप में 3 digits का एक numeric status code भेजते हैं।

इन status codes के साथ एक associated name होता है जिससे उन्हें पहचानने में मदद मिलती है, लेकिन महत्वपूर्ण हिस्सा number होता है।

संक्षेप में:

• 100 - 199 "Information" के लिए होते हैं। आप इन्हें सीधे बहुत कम इस्तेमाल करते हैं। इन status codes वाले responses में body नहीं हो सकती।
• 200 - 299 "Successful" responses के लिए होते हैं। ये वे हैं जिन्हें आप सबसे ज़्यादा इस्तेमाल करेंगे।
  • 200 default status code है, जिसका मतलब है कि सब कुछ "OK" था।
  • एक और उदाहरण 201, "Created" होगा। इसे आमतौर पर database में नया record बनाने के बाद इस्तेमाल किया जाता है।
  • एक विशेष case 204, "No Content" है। यह response तब इस्तेमाल होता है जब client को return करने के लिए कोई content नहीं होता, और इसलिए response में body नहीं होनी चाहिए।
• 300 - 399 "Redirection" के लिए होते हैं। इन status codes वाले responses में body हो भी सकती है और नहीं भी, सिवाय 304, "Not Modified" के, जिसमें body नहीं होनी चाहिए।
• 400 - 499 "Client error" responses के लिए होते हैं। ये दूसरा type है जिसे आप शायद सबसे ज़्यादा इस्तेमाल करेंगे।
  • एक उदाहरण 404 है, "Not Found" response के लिए।
  • client से आने वाली generic errors के लिए, आप सिर्फ़ 400 इस्तेमाल कर सकते हैं।
• 500 - 599 server errors के लिए होते हैं। आप इन्हें लगभग कभी सीधे इस्तेमाल नहीं करते। जब आपके application code या server के किसी हिस्से में कुछ गड़बड़ होती है, तो यह अपने-आप इन status codes में से एक return करेगा।

नाम याद रखने का shortcut¶

आइए पिछले example को फिर से देखें:

from fastapi import FastAPI

app = FastAPI()


@app.post("/items/", status_code=201)
async def create_item(name: str):
    return {"name": name}

201 "Created" के लिए status code है।

लेकिन आपको यह याद रखने की ज़रूरत नहीं है कि इनमें से हर code का क्या मतलब है।

आप fastapi.status से convenience variables इस्तेमाल कर सकते हैं।

from fastapi import FastAPI, status

app = FastAPI()


@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

वे सिर्फ़ एक सुविधा हैं, उनमें वही number होता है, लेकिन इस तरह आप उन्हें खोजने के लिए editor के autocomplete का इस्तेमाल कर सकते हैं:

default बदलना¶

बाद में, Advanced User Guide में, आप देखेंगे कि यहाँ declare किए जा रहे default से अलग status code कैसे return किया जाता है।