ماژول‌های route اپلیکیشن

چیست؟

یک ماژول route اپلیکیشن کلاسی است که از FusionBaseApi ارث می‌برد و با یک قالب مسیر ثبت می‌شود. متدهای HTTP convention و مسیرهای HTTP سفارشی اختیاری به endpointهای mount‌شده در fusion-core تبدیل می‌شوند.

چرا؟

گروه‌بندی handlerها روی یک کلاس، سطح HTTP یک resource را منسجم نگه می‌دارد و اجازه می‌دهد [module] یک stem پایدار مسیر از نام کلاس بسازد.

چه زمانی؟

برای هر resource HTTP (یا گروه منسجم endpointها) که اپلیکیشن شما در معرض می‌گذارد، از یک ماژول route استفاده کنید.

ساخت ماژول route (پایتون)

# src/modules/users/users.py
from fusion_framework.api import FusionBaseApi
from fusion_framework.route import route
from fusion_framework.http_route import http_get, http_post
from fusion_framework import status


@route(
    "api/[module]/",
    tags=["users"],
    desc="User resource",
    version="v1",
)
class UserModule(FusionBaseApi):
    def get(self):
        return self.response({"users": []}, status=status.HTTP_SUCCESS)

    @http_get("profile/[action]", title="Current profile action")
    def ProfileAction(self):
        return self.response({"profile": True}, status=status.HTTP_SUCCESS)

    @http_post("create/[action]", title="Create user")
    def CreateAction(self):
        return self.response({"created": True}, status=status.HTTP_SUCCESS)

ثبت با import از نقطهٔ ورود:

# main.py
import src.modules.users.users  # noqa: F401 — @route را اجرا می‌کند

from fusion_framework.app import FusionApp
from fusion_framework.config import get_settings, load_settings_module

def main() -> None:
    load_settings_module("settings")
    FusionApp(get_settings()).listen()

if __name__ == "__main__":
    main()

مسیرهای تولیدشده

UserModule → [module] = user. ProfileAction → [action] = profile. CreateAction → [action] = create.

Convention در برابر مسیرهای سفارشی

هر دو می‌توانند روی یک کلاس هم‌زیستی داشته باشند. جزئیات: Router پایتون · مسیرهای HTTP سفارشی.

گزینه‌های route

چک‌لیست ثبت

1. فایل را زیر src/modules/... بسازید
2. از FusionBaseApi زیرکلاس بگیرید
3. @route / route() / [Route] را اعمال کنید
4. ماژول را از entrypoint قبل از listen() import کنید
5. (C#) صریحاً Route.Register<T>() را صدا بزنید

TypeScript / C#

همان معنا با syntax متفاوت — صفحات router زبان:

• TypeScript
• C#

بهترین شیوه‌ها

• یک resource اصلی به‌ازای هر کلاس
• Startup را بیرون از فایل‌های ماژول نگه دارید
• [module] را به hard-code کردن نام resource ترجیح دهید
• برای تغییرات شکستهٔ API از version= استفاده کنید

همچنین ببینید

• FMA
• پکیج‌های قابل استفادهٔ مجدد — برای کد مشترک بین اپ‌ها