UR

دستاویزاتماڈل کو سمجھیں۔

بنیادی تصورات

باقی دستاویزات جو الفاظ استعمال کرتے ہیں - راستہ، صفحہ، منظر، جزو، ہینڈلر، اختتامی نقطہ - ہر ایک ایک لائن میں، صفحہ کے لنک کے ساتھ جو گہرائی تک جاتا ہے۔ Nexy میں نئے ہیں؟ Nexy کیا ہے؟ سے شروع کریں۔

ان دستاویزات کو کیسے پڑھیں

سطح وہ سوال جس کا جواب دیتا ہے۔ سے شروع کریں۔
ایپلیکیشن فن تعمیر کون سی پرت درخواست کا جواب دیتی ہے، اور کیا کرنے سے انکار کرتی ہے۔ Nexy کیسے کام کرتا ہے
درخواست کا ڈھانچہ کوڈ کہاں رہتا ہے، اور فائل کیا بنتی ہے۔ پروجیکٹ کا ڈھانچہ
پیش کش اور پیش کش قاری کیا دیکھتا ہے، اور HTML کون تیار کرتا ہے۔ آراء، رینڈرنگ
درخواست کا تعامل قاری کیا کرتا ہے، اور جواب میں کیا چلتا ہے۔ اعمال

سطحوں کو اس ترتیب میں ایک بار پڑھا جاتا ہے۔ اس کے بعد، آپ کو جس صفحہ کی ضرورت ہے وہ ایک تلاش ہے، نہ کہ کورس۔

ایپلیکیشن فن تعمیر

یہ فیصلہ کرنے کے تین طریقے کہ کون سا کوڈ یو آر ایل کا جواب دیتا ہے۔ وہ متبادل ہیں، پرتیں نہیں:

  • فائل پر مبنی روٹنگ (FBR): src/routes/ کے تحت فائل ایک روٹ ہے۔ پہلے سے طے شدہ۔
  • ماڈیولر راؤٹر: NestJS طرز کے کوڈ بیس کے لیے src/apps/ کے تحت کنٹرولرز اور ماڈیولز، ڈیکوریٹرز کے ساتھ اعلان کردہ۔
  • حسب ضرورت روٹر: ایک موجودہ FastAPI APIRouter ایپلی کیشن میں شامل ہے۔

انتخاب nexyconfig.py میں NexyConfig کلاس کی ایک لائن ہے۔

فائل پر مبنی روٹنگ کو کسی لائن کی ضرورت نہیں ہے: بغیر useRouter، Nexy پڑھتا ہے src/routes/۔

nexyconfig.py
from nexy.core.models import NexyConfigModel  class NexyConfig(NexyConfigModel):    pass  # file-based: no useRouter, the files of src/routes/ are the routes

ماڈیولر راؤٹر src/apps/ کا روٹ ماڈیول ہے:

nexyconfig.py
from nexy.core.models import NexyConfigModel from src.apps.app_module import AppModule  class NexyConfig(NexyConfigModel):    useRouter = AppModule  # modular: the root module of src/apps/

حسب ضرورت روٹر ایک APIRouter ہے جو آپ کے پاس پہلے سے موجود ہے:

nexyconfig.py
from nexy.core.models import NexyConfigModel from src.legacy import api  # an APIRouter you already have  class NexyConfig(NexyConfigModel):    useRouter = api  # custom: your router, included as it is

تین میں سے کسی ایک کا انتخاب کرنا ایک فیصلہ ہے۔ فرنٹ اینڈ فریم ورک کا انتخاب ایک اور ہے، الگ الگ: دیکھیں روٹر کا انتخاب کریں اور دیکھے۔

درخواست کا ڈھانچہ

پانچ تصورات جو کہ Next.js سے آنے والا قاری عموماً ایک میں ضم ہوجاتا ہے۔ وہ ایک ہی چیز نہیں ہیں، اور فرق زیادہ تر سوالات کی وضاحت کرتا ہے "میرا صفحہ کیوں پیش نہیں کر رہا ہے"۔

تصور یہ کیا ہے یہ کیا نہیں ہے۔
راستہ ایک URL پیٹرن، جو ایک فائل کے راستے سے تیار ہوتا ہے۔ ایک فائل: ایک فائل کئی یو آر ایل کا جواب دے سکتی ہے ([slug])
صفحہ ایک روٹ فائل جو ایک منظر پیش کرتی ہے: .nexy، .md، .mdx، .tsx، .vue، .svelte ایک اختتامی نقطہ: یہ ایک دستاویز کا جواب دیتا ہے، ڈیٹا نہیں۔
دیکھیں صفحہ کا باڈی کیا بناتا ہے: Jinja2 اور Python، Markdown، یا کلائنٹ کا جزو ایک راستہ: ایک ہی منظر کئی صفحات کی خدمت کرسکتا ہے۔
جزو دوبارہ قابل استعمال ٹکڑا ایک صفحہ درآمد کرتا ہے۔ ایک راستہ: سرور موڈ میں ایک جزو کبھی بھی خود سے پیش نہیں ہوتا ہے۔
روٹ ہینڈلر ایک .py روٹ فائل کا فنکشن، جس کا نام HTTP طریقہ (GET، POST، …) ایک صفحہ: یہ JSON، ایک فائل یا ایک Response لوٹاتا ہے
نقطہ اختتام جوڑا (URL، طریقہ) جس کا ہینڈلر جواب دیتا ہے۔ ایک ہینڈلر: ایک فائل کئی اختتامی نکات کا جواب دے سکتی ہے۔

ایک جملے میں: ایک صفحہ ایک روٹ فائل ہے، ایک منظر وہ ہے جو اسے پیش کرتا ہے، ایک جزو وہ ہے جسے صفحہ دوبارہ استعمال کرتا ہے، ایک ہینڈلر ایک اختتامی نقطہ کا جواب دیتا ہے۔

تمام پانچ ایک چھوٹے پروجیکٹ میں:

src/
routes/
blog/[slug].nexya route (/blog/{slug}) whose file is a page
api/posts.pya route whose handlers answer two endpoints
components/
Like.tsxa component: never served on its own
src/routes/blog/[slug].nexy
---from "@/components/Like.tsx" import Like slug: prop[str]---<h1>{{ slug }}</h1><Like post="{{ slug }}" />

فرنٹ میٹر اور اس کے نیچے کا سانچہ صفحہ کا منظر ہے۔ Like وہ جزو ہے جسے یہ دوبارہ استعمال کرتا ہے۔

src/routes/api/posts.py
async def GET():  # the endpoint GET /api/posts    return {"posts": []}  async def POST():  # the endpoint POST /api/posts    return {"created": True}

ماڈیولر راؤٹر کے ساتھ، روٹ ایک کنٹرولر کا راستہ ہے، اور ایک ہینڈلر اس کے طریقوں میں سے ایک ہے، جسے HTTP فعل کے نام سے منسوب کیا گیا ہے:

src/
apps/
app_module.pythe root module: lists the controllers
posts_controller.py a route (/api/posts) whose handlers answer two endpoints
components/
Like.tsxa component: never served on its own
src/apps/posts_controller.py
from nexy.decorators import Controller  @Controller("/api/posts")class PostsController:    async def get(self) -> dict:  # the endpoint GET /api/posts        return {"posts": []}     async def post(self) -> dict:  # the endpoint POST /api/posts        return {"created": True}
src/apps/app_module.py
from nexy.decorators import Module from .posts_controller import PostsController  @Module()class AppModule:    controllers = [PostsController]

ایک صفحہ اب بھی src/routes/ کی فائل ہے، یا ایک کنٹرولر useViews کے ساتھ واپس آتا ہے۔

حسب ضرورت روٹر کے ساتھ، روٹ آپ کے APIRouter کا ایک راستہ ہے، اور ایک ہینڈلر وہ فنکشن ہے جو اس کا ڈیکوریٹر رجسٹر کرتا ہے:

src/legacy.py
from fastapi import APIRouter api = APIRouter()  @api.get("/api/posts")  # the endpoint GET /api/postsasync def list_posts():    return {"posts": []}  @api.post("/api/posts")  # the endpoint POST /api/postsasync def create_post():    return {"created": True}

صفحات ابھی بھی src/routes/ کی فائلیں ہیں: شامل راستوں کے آگے ایک .nexy صفحہ جواب دیتا ہے۔

دو مزید الفاظ جو ہر جگہ واپس آتے ہیں:

  • لے آؤٹ: ایک layout.* فائل جو اپنے فولڈر کے نیچے صفحات کو سمیٹتی ہے۔ جڑ HTML دستاویز کا مالک ہے۔ دیکھیں لے آؤٹ۔
  • انحصار: ایک فنکشن جو ہینڈلر سے پہلے چلتا ہے، فی روٹ یا فی فولڈر لاگو ہوتا ہے۔ دیکھیں انحصار۔

پیش کش اور پیش کش

دو آزاد فیصلے، اکثر الجھ جاتے ہیں:

  • فارمیٹ فیصلہ کرتا ہے کہ کون سی فائل صفحہ کو رینڈر کرتی ہے: ملاحظات۔
  • موڈ فیصلہ کرتا ہے کہ HTML کون تیار کرتا ہے اور کب: رینڈرنگ۔
تصور ایک لائن
سرور موڈ سرور .nexy اور .md صفحات پیش کرتا ہے۔ اجزاء جزیرے ہیں (موڈز)
کلائنٹ موڈ useCSR = True: فریم ورک فائلیں راستے ہیں، اور نیویگیشن براؤزر میں ہوتی ہے۔
SSR، ISR، CSR، جزائر چار رینڈرنگ موڈز، فی صفحہ طے کیا گیا سوائے CSR کے، جو فی پروجیکٹ ہے (رینڈرنگ)
ہائیڈریشن براؤزر HTML کے ساتھ ایک فریم ورک منسلک کرتا ہے جو سرور نے پہلے ہی بھیج دیا ہے (جزیرے)
سہارے وہ اقدار جو والدین کسی جزو کو منتقل کرتے ہیں، name: prop[type] کا اعلان .nexy فائل میں کیا جاتا ہے (.nexy فائلز)

ایک جزیرے کے ساتھ سرور موڈ کا صفحہ: سرور صفحہ کو رینڈر کرتا ہے، براؤزر صرف اس وقت چارٹ کو ہائیڈریٹ کرتا ہے جب وہ منظر میں اسکرول کرتا ہے۔

src/routes/sales.nexy
---from "@/components/Chart.tsx" import Chart---<h1>Sales</h1><Chart directive="client:visible" />

جزیرہ منظر میں جاتا ہے، اور کنٹرولر منظر کو واپس کرتا ہے:

src/apps/sales_view.nexy
---from "@/components/Chart.tsx" import Chart---<h1>Sales</h1><Chart directive="client:visible" />
src/apps/sales_controller.py
from nexy.decorators import Controllerfrom nexy.hooks import useViews  @Controller("/sales")class SalesController:    async def get(self):        return useViews("src/apps/sales_view.nexy")

درخواست کا تعامل

تصور ایک لائن
ایکشن ایک Python فنکشن نشان زد @Action، ایک POST کے طور پر پیش کیا گیا، فارم سے کال کیا جا سکتا ہے یا ٹائپ شدہ فنکشن کے طور پر (عمل)
فارم ایک ایچ ٹی ایم ایل فارم جو ایک ایکشن پر پوسٹ کرتا ہے، توثیق کی خرابیوں کے ساتھ صفحہ پر واپس آتا ہے (ایکشن)
نیویگیشن لنکس جو پہلے سے تیار کرتے ہیں، اور ہکس جو راستے، استفسار، کوکیز اور سیشن کو پڑھتے ہیں (ہکس)
ڈیٹا بازیافت کرنا صفحہ یا ہینڈلر کے ذریعہ کیا گیا ہے جس کی ضرورت ہے۔ Nexy بغیر کسی کلائنٹ کی ڈیٹا لیئر بھیجتا ہے (ہینڈلرز)

ایک عمل اور فارم جو اس پر پوسٹ کرتا ہے، جو کسی بھی اسکرپٹ کے لوڈ ہونے سے پہلے کام کرتا ہے:

src/actions/newsletter.py
from nexy.decorators import Action  @Actionasync def subscribe(email: str) -> bool:    return True
src/routes/index.nexy
<form method="post" action="{{ __actions_path['subscribe'] }}">  <input name="email" type="email">  <button type="submit">Subscribe</button></form>
src/apps/home_view.nexy
<form method="post" action="{{ __actions_path['subscribe'] }}">  <input name="email" type="email">  <button type="submit">Subscribe</button></form>

Nexy کیا نہیں کرتا

تصدیق، اجازت، ڈیٹا بیس، بین الاقوامی کاری، پس منظر کی ملازمتیں، ای میل، ادائیگیاں اور تلاش آپ کی درخواست کی ذمہ داری ہیں، نہ کہ فریم ورک کی۔ Nexy ایکسٹینشن پوائنٹ دیتا ہے اور کہتا ہے کہ ہر ایک کو کہاں سے لگانا ہے: دیکھیں Nexy آپ کے لیے کیا چھوڑتا ہے۔

توثیق، مثال کے طور پر، اس فولڈر کے انحصار میں پلگ ان کی حفاظت کرتا ہے۔ Nexy اسے نیچے کے ہر راستے سے پہلے چلاتا ہے۔ صارف کون ہے آپ کا فیصلہ برقرار ہے:

src/routes/account/dependencies.py
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]

توثیق، مثال کے طور پر، اس کی حفاظت کرنے والے کنٹرولر پر ایک گارڈ لگاتا ہے۔ Nexy اسے کلاس کے ہر ہینڈلر سے پہلے چلاتا ہے۔ صارف کون ہے آپ کا فیصلہ برقرار ہے:

src/apps/account_controller.py
from nexy import unauthorizedfrom nexy.decorators import Controller, UseGuardfrom nexy.http import Request  def require_login(request: Request) -> None:    if not request.session.get("user"):        unauthorized(scheme="Bearer")  @Controller("/account")@UseGuard(require_login)class AccountController:    async def get(self) -> dict:        return {"ok": True}

توثیق، مثال کے طور پر، روٹر کے انحصار میں پلگ ان کی حفاظت کرتا ہے، جیسا کہ FastAPI میں؛ صارف کون ہے آپ کا فیصلہ برقرار ہے:

src/account.py
from fastapi import APIRouter, Depends from nexy import unauthorizedfrom nexy.http import Request  def require_login(request: Request) -> None:    if not request.session.get("user"):        unauthorized(scheme="Bearer")  api = APIRouter(prefix="/account", dependencies=[Depends(require_login)])

وجہ اس کی اپنی خاطر minimalism نہیں ہے: ایک فریم ورک جو آپ کے ORM یا آپ کی auth لائبریری کو چنتا ہے اس نے کچھ فیصلہ کیا ہے جس کا فیصلہ صرف آپ کی درخواست ہی کر سکتی ہے۔

اگلے اقدامات

GitHub پر ترمیم کریں

Enter نتیجہ کھولتا ہے، Esc بند کرتا ہے۔