الوثائق/المعالجات والأخطاء

صفحات الخطأ

الطلب الذي يفشل يجب أن يجيب مثل بقية موقعك: صفحة بكلماتك الخاصة للزائر، نفس فشل JSON لعميل API. يجيب Nexy على كليهما، ويحل ملف واحد محل كل إجابة.

هذه الصفحة هي الخريطة: أي ملف يجيب على أي حالة، وكيفية إنشاء ملفك الأول. تحصل صفحات المجلد على الصفحة الخاصة بهم.

فشل واحد، إجابتان

a request that fails
      │
      ├── a browser (Accept: text/html)              ──►  an HTML page
      └── an API client (Accept: application/json)   ──►  {"detail": "…"}  with the same status

the HTML page
      ├── the deepest folder of the URL that holds a file   ──►  your file
      └── no folder of the chain holds one                 ──►  the built-in page

صفحتك الأولى

أنشئ src/routes/notfound.nexy واكتب ما يجب على الزائر قراءته:

---metadata = {"title": "Page not found"}---<h1>Page not found</h1><p>The page moved or never existed. <a href="/">Back home</a>.</p>

احفظ واطلب عنوان URL الذي لا يخدم أي شيء:

curl -i -H "Accept: text/html" http://localhost:3000/nowhere# HTTP/1.1 404 Not Found

الملف الموجود في جذر المسارات يجيب على المشروع بأكمله؛ نسخة في مجلد تجيب فقط على هذا المجلد وتحتفظ بالباقي كما هو. بدون أي ملف، يقدم Nexy صفحته ذات التصميم المدمج.

أي ملف يجيب

اترك صفحة أو إجابة من الكود

redirect، permanentRedirect، notFound، forbidden و unauthorized يرفعون استثناء HTTP، لذلك يعمل نفس الاستدعاء في صفحة .nexy، ومعالج API، ووحدة تحكم نمطية، وحارس و dependencies.py. لديهم نفس الأسماء على العميل (@nexy/client).

---from nexy import notFound, redirect from src.posts import find slug: prop[str]post = find(slug)if post is None:    notFound()if post.moved_to:    redirect(post.moved_to)---<h1>{{ post.title }}</h1>

إعادة توجيه الإجابات برأس Location وبدون صفحة، أيضًا إلى عميل API. قم ببناء الوجهة من القيم التي تثق بها: أ redirect(request.query_params["next"]) يرسل الزوار أينما يشير الرابط. تم رفض الوجهة التي تحتوي على فاصل أسطر.

يقوم الحارس بحماية مجلد كامل:

from nexy import unauthorizedfrom nexy.http import Request  def require_login(request: Request) -> None:    if not request.session.get("user"):        unauthorized(scheme="Bearer")  dependencies = [require_login]

HTML أو JSON

يجيب نفس الاستثناء بشكل مختلف اعتمادًا على من يسأل:

• يحصل المتصفح (Accept: text/html) على صفحة HTML. تم حذف التفاصيل من HTML، لذا لا يمكن للرسالة المبنية من إدخال المستخدم إدخال العلامات.
• العميل الذي يطلب JSON وليس صفحة (Accept: application/json) يحصل على {"detail": "..."} بنفس رمز الحالة.

from nexy.http import HTTPException  async def GET(id: int):    if id > 100:        raise HTTPException(status_code=403, detail="Out of range")    return {"id": id}

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

الاستثناءات غير المعالجة

استثناء هو أنه لا يتم تسجيل أي شيء تتم معالجته مرة واحدة، باستثناء مصدره والكود المحيط به، ويتم الرد عليه وفقًا للوضع.

  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}

المرجع هو ثمانية أحرف جديدة لكل فشل. يمكن للزائر أن يقتبسها، ويمكنك العثور على أثر التتبع من خلال البحث عنها في السجل. لا الاستثناء ولا الكود يصل إلى الزائر في الإنتاج. يستبدل errors.nexy المخصص الصفحة فقط؛ يبقى خط السجل.

أخطاء التحقق من الصحة

يجيب الرأس أو معلمة الاستعلام أو حقل النص المفقود على 422 بنص JSON الخاص بـ FastAPI، لكل عميل. انظر التصديق والأخطاء.

الخطوات التالية

• صفحات الخطأ لكل مجلد: 404 أو 403 أو 401 خاصة بك في مجلد واحد
• المسارات الديناميكية
• مسارات واجهة برمجة التطبيقات
• الاختبار

انسخ الصفحة بصيغة Markdown حرِّر على GitHub