الوثائقالأوامر والتكوين
التكوين
التكوين هو فئة في nexyconfig.py في جذر المشروع. يقوم Nexy بتحميله من الدليل الذي يعمل فيه؛ يستخدم المشروع بدون الملف الإعدادات الافتراضية.
from nexy.core.models import NexyConfigModelfrom nexy.frontend import react class NexyConfig(NexyConfigModel): useFF = react() usePort = 3000 useTitle = "My App" useAliases = {"@": "src"}الخادم
| الميدان | الافتراضي | معنى |
|---|---|---|
usePort |
3000 |
منفذ لـ dev و start |
useHost |
"0.0.0.0" |
ربط العنوان |
useSslKeyfile، useSslCertfile |
None |
خدمة HTTPS مباشرة |
useDevTools |
True |
يضيف شريط الأدوات nexy dev إلى كل صفحة (معلومات الصفحة، والمسارات، والأخطاء، والتكوين)؛ False يزيله. لا يوجد أبدا في الإنتاج |
useHealth |
False |
يخدم GET /health/live و GET /health/ready لموازنات التحميل وتحقيقات Kubernetes؛ راجع نشر |
useWorkers |
0 |
العمليات nx start تعمل؛ 0 هو واحد لكل وحدة معالجة مركزية على Linux وmacOS، وواحد على Windows |
useCSR |
False |
وضع التوجيه من جانب العميل؛ .nexy الطرق معطلة |
الطرق
| الميدان | الافتراضي | معنى |
|---|---|---|
useRouter |
None |
APIRouter مثيل أو فئة مثبتة بجوار المسارات المستندة إلى الملف؛ None يعني المستند إلى الملف فقط |
excludeDirs |
["templates", "extension", "docs"] |
تم تخطي الدلائل عند مسح المسارات |
useAliases |
None |
استيراد الأسماء المستعارة، على سبيل المثال {"@": "src"} (@/components/Counter.tsx يعني src/components/Counter.tsx)؛ nx new يكتب الذي اخترته، ويتبعه Vite و tsconfig.json |
الواجهة الأمامية
| الميدان | الافتراضي | معنى |
|---|---|---|
useFF |
None |
مصنع إطار العميل: react()، vue()، svelte()، solid()، preact() |
useVite |
True |
بناء وتقديم حزم العملاء مع Vite |
useMarkdownExtensions |
[] |
ملحقات إضافية للعرض .md/.mdx |
useWatchExtensions |
None |
ملحقات إضافية يشاهدها خادم التطوير |
useWatchExcludePatterns |
None |
أنماط الكرة الأرضية التي يتجاهلها خادم التطوير |
من المفيد معرفة:
NexyConfigModelيعلنuseVite = False؛ وقت التشغيلConfigالافتراضي هوTrue.
أسماء الملفات المحجوزة
يضيف كل حقل ملحقات إلى دور محجوز. useLayoutExtensions = ["md"] يجعل layout.md محجوزاً، مثل layout.nexy تماماً.
| الميدان | يضيف ملحقات إلى |
|---|---|
useLayoutExtensions |
layout.* |
useNotFoundExtensions |
notfound.* |
useErrorsExtensions |
errors.* |
useForbiddenExtensions |
forbidden.* |
useUnauthorizedExtensions |
unauthorized.* |
useLoadingExtensions |
loading.* |
وثائق واجهة برمجة التطبيقات
| الميدان | الافتراضي | معنى |
|---|---|---|
useDocs |
True |
خدمة الصفحة المرجعية العددية؛ /openapi.json يقدم على كلا الحالتين |
useDocsUrl |
"/docs" |
مسار الصفحة المرجعية لواجهة برمجة التطبيقات |
useRedocsUrl |
"/redocs" |
تم الإعلان عنه ولكن لم يتم تثبيت أي طريق |
useTitle |
"Nexy App" |
OpenAPI العنوان وعنوان الصفحة ("Nexy" في NexyConfigModel) |
/docs مجانا لصفحة من المشروع
يجيب مرجع API على /docs قبل أي مسار، لذلك لا يتم عرض src/routes/docs.nexy أو src/routes/docs/[[...slug]].nexy هناك أبدًا. nx dev و nx start قم بتسمية هذه الصفحة عند بدء التشغيل. انقل المرجع بـ useDocsUrl:
from nexy.core.models import NexyConfigModel class NexyConfig(NexyConfigModel): useDocsUrl = "/api-reference"أو أطفئه ب useDocs = False. /openapi.json يبقى مخدومًا في الحالتين: أبعد مسارات المشروع عن ذلك المسار.
الوسيطة
| الميدان | الافتراضي | معنى |
|---|---|---|
useMiddlewares |
[] |
فئات البرمجيات الوسيطة ASGI |
useCORS |
None |
كوارج ل CORSMiddleware |
useGZip |
None |
كوارج ل GZipMiddleware |
useTrustedHost |
None |
كوارج ل TrustedHostMiddleware |
useSession |
None |
كوارج ل SessionMiddleware |
useAuth |
None |
تكوين البرامج الوسيطة للمصادقة |
useHTTPSRedirect |
False |
إعادة توجيه HTTP إلى HTTPS |
Markdown
| الميدان | الافتراضي | معنى |
|---|---|---|
useTocDepth |
"2-6" |
مستويات العناوين المدرجة في جدول المحتويات |
useTocTitle |
"Table of Contents" |
عنوان جدول المحتويات |
useTocAuto |
True |
إنشاء جدول محتويات لصفحات Markdown |
الطرق خارج شجرة الملفات
قم ببناء FastAPI APIRouter وتركيبه بـ useRouter. يتم تقديمه بجوار المسارات المستندة إلى الملف:
from fastapi import APIRouterfrom nexy.core.models import NexyConfigModel router = APIRouter() @router.get("/health")def health(): return {"status": "ok"} class NexyConfig(NexyConfigModel): useRouter = routerتتم قراءة الإعدادات الافتراضية أعلاه من nexy/core/config.py.
أعلن، لم يقرأ بعد
هذه الحقول موجودة في NexyConfigModel ولكن لا يوجد كود يستهلكها. إعدادها ليس له أي تأثير:
useViteDevUrl، useRTL.
الخطوات التالية
- i18n: التدويل
- الواجهة الأمامية:
useFFوبناء العميل - نشر: خيارات الإنتاج