दस्तावेज़/Python एपीआई और त्रुटियां

अपवाद और त्रुटियाँ

एक अनुरोध चार स्थानों पर विफल हो सकता है, और नेक्सी प्रत्येक का अलग-अलग उत्तर देता है। यह पृष्ठ अनुक्रमणिका है: जो स्थिति आप देखते हैं उसे ढूंढें, फिर वह पंक्ति जिसने इसे उत्पन्न किया, फिर वह फ़ाइल जो मुख्य भाग का निर्णय करती है।

लघु संस्करण

एपीआई क्लाइंट एक अनुरोध है जिसका Accept हेडर JSON मांगता है न कि कोई पेज:

curl -H "Accept: application/json" http://localhost:3000/api/items/500# {"detail":"Out of range"}

विफलता कहां से आती है

Browser ──► Middleware ──► Router ──► Page or handler
                 │            │             │
                 │            │             ├─ return ───────────► 200
                 │            │             ├─ HTTPException ────► its status
                 │            │             └─ other exception ───► 500
                 │            └─ no match ────────────────────────► 404
                 └─ raises ──────────────────────────────────────► 500

कहीं से भी निकलें

redirect, permanentRedirect, notFound, forbidden और unauthorized एक HTTP अपवाद बढ़ाते हैं, इसलिए एक ही कॉल .nexy पेज, एक एपीआई हैंडलर, एक मॉड्यूलर नियंत्रक, एक गार्ड, एक dependencies.py और एक कार्रवाई में काम करती है।

from nexy import notFound, redirect from src.posts import find  async def GET(slug: str):    post = find(slug)    if post is None:        notFound("No such post")    if post.moved_to:        redirect(post.moved_to)    return post

from nexy import notFound, redirectfrom nexy.decorators import Controller from src.posts import find  @Controller("/posts/{slug}")class PostsBySlugController:    async def get(self, slug: str):        post = find(slug)        if post is None:            notFound("No such post")        if post.moved_to:            redirect(post.moved_to)        return post

मंजिल का निर्माण उन मूल्यों से करें जिन पर आप भरोसा करते हैं। redirect(request.query_params["next"]) जहां भी लिंक कहा गया है वहां आगंतुकों को भेजता है; यह एक खुला रीडायरेक्ट है. जिस गंतव्य पर लाइन ब्रेक होता है उसे अस्वीकार कर दिया जाता है।

सत्यापन: 422, या 404

हैंडलर पैरामीटर्स को उनके एनोटेशन के विरुद्ध FastAPI द्वारा मान्य किया जाता है।

from nexy.http import Header  async def GET(q: str, limit: int = 10, x_token: str = Header(...)):    return {"q": q, "limit": limit}

from nexy.decorators import Controllerfrom nexy.http import Header  @Controller("/api/search")class SearchApiController:    async def get(self, q: str, limit: int = 10, x_token: str = Header(...)):        return {"q": q, "limit": limit}

422 बॉडी FastAPI का मानक आकार है, इसलिए क्लाइंट और जेनरेट किए गए एसडीके काम करते रहते हैं:

{"detail": [{"loc": ["query", "q"], "msg": "Field required", "type": "missing"}]}

किसी फॉर्म या कार्रवाई के लिए, ग्राहक को ActionError के साथ status और detail प्राप्त होता है; एक 422 प्रति फ़ील्ड एक संदेश के साथ error.fields भी भरता है। क्रियाएँ देखें।

कस्टम त्रुटि पृष्ठ

<h1>Page not found</h1><p>The link may be old. <a href="/">Start from the home page</a>.</p>

<h1>Something went wrong</h1><p>Try again in a moment.</p>

हैंडल न किए गए अपवाद

एक अपवाद यह है कि पकड़ी गई कोई भी चीज़ एक बार लॉग नहीं की जाती है, उसके संदर्भ के साथ, वह कहां से आई है और उसके आसपास का कोड क्या है। स्थिति 500 है, और शरीर पर्यावरण पर निर्भर करता है।

  x ZeroDivisionError: division by zero  GET /boom  ref fe6a5217    at src/routes/boom.py:2 in GET       1 | def GET():       2 |     return {"a": 1 / 0}

संदर्भ आठ वर्णों का है, प्रत्येक विफलता के लिए नया। कोई विज़िटर इसे उद्धृत कर सकता है, और आप इसके लिए लॉग में खोजकर ट्रेसबैक ढूंढ सकते हैं। उत्पादन में न तो अपवाद और न ही कोड विज़िटर तक पहुंचता है।

क्रियाएँ और रूप

एक क्रिया एक उत्पन्न पथ के साथ एक POST समापन बिंदु है। इसकी विफलताएँ उन्हीं नियमों का पालन करती हैं:

कार्रवाई पथ पर JavaScript पोस्ट के बिना एक फॉर्म; एक सफलता पृष्ठ पर वापस 303 उत्तर देती है, एक विफलता त्रुटि पृष्ठ दिखाती है। क्रियाएँ देखें।

जब कोई पृष्ठ गलत उत्तर देता है तो एक चेकलिस्ट

1. स्थिति देखें, पृष्ठ नहीं। एक प्रथा notfound.nexy अभी भी 404 का उत्तर देती है।
2. टर्मिनल पढ़ें। जो पृष्ठ आयात करने में विफल रहता है वह पंजीकृत नहीं होता है, इसलिए फ़ाइल मौजूद होने पर इसका यूआरएल 404 उत्तर देता है। आयात त्रुटि लॉग में है.
3. एक्सटेंशन की जांच करें। useCSR = True के साथ, .nexy पेज सर्वर मोड से संबंधित हैं; ग़लत मोड में कोई पेज रूट नहीं है.
4. गहराई की जाँच करें। एक notfound.nexy या errors.nexy केवल तभी काम करता है जब रूट कॉपी मौजूद हो।
5. आपके एपीआई क्लाइंट को प्राप्त होने वाले आकार को देखने के लिए Accept: application/json के साथ JSON मांगें।
6. जब आप कोई समस्या खोलते हैं या लॉग खोजते हैं तो 500 का संदर्भ उद्धृत करें।

अगले चरण

• त्रुटि पृष्ठ: संपूर्ण पृष्ठ व्यवहार, उदाहरण सहित
• सत्यापन और त्रुटियाँ: एपीआई हैंडलर
• समस्या निवारण: वे त्रुटियाँ जो लोग वास्तव में करते हैं
• परीक्षण: एक स्थिति और एक निकाय का दावा करें

पृष्ठ को Markdown के रूप में कॉपी करें GitHub पर संपादित करें