الوثائق/جهاز التوجيه المعياري

الحراس والبيانات الوصفية

أدوات تزيين تحمي المسار وتصفه في مخطط OpenAPI.

حراس

@UseGuard(*guards) يعمل على وحدة تحكم (كل طريقة) أو على طريقة واحدة. تتم إضافة كل حارس كـ FastAPI Depends، لذلك يعلن عن المعلمات التي يحتاجها ويرفع لرفض الاستدعاء:

from fastapi import Header, HTTPExceptionfrom nexy.decorators import Controller, UseGuard  def require_token(x_token: str = Header(...)) -> None:    if x_token != "secret":        raise HTTPException(status_code=403, detail="Forbidden")  @Controller("/admin")@UseGuard(require_token)class AdminController:    async def get(self) -> dict:        return {"ok": True}

مصمم ديكورات وسطية

@Middleware(*middlewares) يتصرف بنفس الطريقة: هذه هي FastAPI تبعيات، وليست برامج ASGI الوسيطة. بالنسبة للبرامج الوسيطة الحقيقية لـ ASGI، استخدم useMiddlewares في التكوين أو البرامج الوسيطة والأمان.

البيانات الوصفية للطريق

@UseRoute(...) يقوم بتعيين OpenAPI البيانات الوصفية. لا يغير المسار.

الردود

@UseResponse(...) يحدد status_code، response_class، response_model، responses وخيارات التسلسل.

from nexy.decorators import Controller, UseResponse, UseRoute  @Controller("/users")class UserController:    @UseRoute(summary="List users", tags=["users"])    @UseResponse(status_code=200)    async def get(self) -> list[dict]:        return []

يتم تقديم مرجع API الذي تم إنشاؤه في /docs ما لم useDocs = False.

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

• حقن التبعية
• مسارات واجهة برمجة التطبيقات: نفس الخيارات للمعالجات القائمة على الملفات

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