ডকুমেন্টেশনফাইল কনভেনশন
ফাইল কনভেনশন
src/routes/ এর অধীনে সংরক্ষিত নাম এবং নিয়ম।
রুট ফাইল
| ফাইল | হয়ে যায় |
|---|---|
index.nexy, index.md, index.mdx, index.py |
এর ডিরেক্টরির রুট |
about.nexy |
/about |
[slug].nexy |
গতিশীল সেগমেন্ট {slug} |
[...path].nexy |
ধরা-সব {path:path} |
(group)/page.nexy |
/page: গ্রুপটি URL-এ উপস্থিত হয় না |
name.py |
API হ্যান্ডলার; ফাংশনের নাম GET, POST, ... হল পদ্ধতি |
name.tsx, .jsx, .vue, .svelte |
ক্লায়েন্ট রুট যখন ফ্রেমওয়ার্ক সক্ষম করা হয় useFF |
src/routes/
index.nexy/
about.nexy/about
(marketing)/
pricing.nexy/pricing
blog/
index.md/blog
[slug].nexy/blog/{slug}
docs/
[...path].nexy/docs/{path:path}
api/
users.pyGET /api/users, POST /api/users
async def GET(): return {"users": []} async def POST(): return {"created": True}সংরক্ষিত ফাইল
| ফাইল | ভূমিকা | বিস্তারিত |
|---|---|---|
layout.nexy |
সার্ভার মোড: এর নীচে প্রতিটি পৃষ্ঠা মোড়ানো; এইচটিএমএল ডকুমেন্টের মালিক রুট | layout.nexy |
layout.tsx |
ক্লায়েন্ট মোড (React): এইচটিএমএল ডকুমেন্টের মালিক রুট, নেস্টেড পৃষ্ঠাগুলি মোড়ানো | layout.tsx |
layout.vue, layout.svelte |
ক্লায়েন্ট মোড: নেস্টেড লেআউট | layout.vue, layout.svelte |
notfound.nexy |
এর ডিরেক্টরির জন্য 404 পৃষ্ঠা | ত্রুটি পৃষ্ঠাগুলি |
errors.nexy |
এর ডিরেক্টরির জন্য 500 পৃষ্ঠা | ত্রুটি পৃষ্ঠাগুলি |
forbidden.nexy |
এর ডিরেক্টরির জন্য 403 পৃষ্ঠা | ফোল্ডার প্রতি ত্রুটি পৃষ্ঠাগুলি |
unauthorized.nexy |
এর ডিরেক্টরির জন্য 401 পৃষ্ঠা | ফোল্ডার প্রতি ত্রুটি পাতা |
loading.nexy |
সংরক্ষিত এখনও রানটাইম প্রভাব নেই | ত্রুটি পৃষ্ঠাগুলি |
middleware.py |
একটি async def middleware(request, call_next) ডিরেক্টরি এবং নীচের অনুরোধগুলি মোড়ানো |
মিডলওয়্যার ফাইল |
dependencies.py |
একটি dependencies = [fn, ...] তালিকা ডিরেক্টরি এবং এর শিশুদের জন্য প্রয়োগ করা হয়েছে |
নির্ভরতা |
__init__.py |
Python প্যাকেজ চিহ্নিতকারী | |
favicon.ico |
পরিবেশিত /favicon.ico |
useLayoutExtensions, useNotFoundExtensions, useErrorsExtensions, useForbiddenExtensions, useUnauthorizedExtensions এবং useLoadingExtensions এই নামের জন্য আরও এক্সটেনশন সংরক্ষণ করে। কনফিগ দেখুন।
টেবিলের দুটি Python ফাইল, একটি ফোল্ডারে পাশাপাশি:
from nexy.http import Request async def middleware(request: Request, call_next): response = await call_next(request) response.headers["x-admin"] = "1" return responsefrom nexy.http import Header, HTTPException def require_admin(x_role: str = Header(...)) -> None: if x_role != "admin": raise HTTPException(status_code=403, detail="Admins only") dependencies = [require_admin]এবং একটি পৃষ্ঠা যা তার ফোল্ডারের 404 এর উত্তর দেয়:
<h1>Page not found</h1><p><a href="/">Back home</a></p>উপেক্ষা করা ফাইল
_বা.দিয়ে শুরু হওয়া একটি ফাইল বা ফোল্ডার: এটি আংশিক, খসড়া এবং সাহায্যকারীর জন্য ব্যবহার করুন।- একটি ফাইল যার এক্সটেনশন প্রকল্পের জন্য সক্রিয় নয়: এটি একটি সতর্কতা সহ এড়িয়ে গেছে৷
src/routes/
index.nexy/
_card.nexyignored: a partial the pages include
_helpers/ignored, with everything inside
format.py
.draft.nexyignored: a draft
URL প্রতি একটি ফাইল
একই ইউআরএলে সমাধান করা দুটি ফাইল উভয় নিবন্ধন করে। blog/index.nexy এর পাশে blog.nexy রাখবেন না।
src/routes/
blog.nexy/blog
blog/
index.nexy/blog as well: keep only one of the two
বাইরে src/routes/
| ফোল্ডার | উদ্দেশ্য |
|---|---|
src/components/ |
পৃষ্ঠা দ্বারা আমদানি করা উপাদান; কখনও রুট |
src/apps/ |
মডুলার রাউটারের কন্ট্রোলার এবং মডিউল |
public/ |
স্ট্যাটিক ফাইল, রুটে পরিবেশিত: public/logo.svg হল /logo.svg (এছাড়াও /public/] এর অধীনে) |
__nexy__/ |
উৎপন্ন আউটপুট; কমিট না |
my-app/
nexyconfig.py
public/
logo.svg/logo.svg
src/
routes/the routes
components/
Counter.tsximported by pages, never served on its own
apps/the modular router, when you use it
__nexy__/generated: add it to .gitignore