Docs/Choose

Modular routing

Modular routing uses classes with decorators instead of files under src/routes/: controllers handle requests, modules group them, and providers are injected. Mount the resulting APIRouter with useRouter in nexyconfig.py.

Set up the router

from nexy.core.models import NexyConfigModel
from src.apps.app_module import AppModule


class NexyConfig(NexyConfigModel):
    useRouter = AppModule

Write a controller

from nexy.decorators import Controller
from nexy.core.types import JsonResponse


@Controller()
class AppController:
    async def get(self) -> JsonResponse:
        return {"message": "Welcome to Nexy Modular API"}

Methods are matched by name, case-insensitively: get, post, put, patch, delete, options, head, trace.

A controller declares one handler per HTTP method; a duplicate raises at startup. Add a prefix with @Controller(prefix="/users") - every handler is mounted on prefix/. async def SOCKET(...) on a controller registers a WebSocket at the same path.

Group controllers in a module

from nexy.decorators import Module
from .app_controller import AppController


@Module()
class AppModule:
    controllers = [AppController]

@Module(prefix="/api") returns an APIRouter. controllers is required; providers, imports and exports are optional. Imported modules are mounted as sub-routers, and their exported providers are resolved at startup.

Views from a controller

A controller can return a page. useViews renders a .nexy view; nest one inside another to wrap it in a layout:

from nexy.decorators import Controller
from nexy.hooks import useViews


@Controller()
class AppController:
    async def get(self):
        return useViews("src/apps/layout.nexy", context={
            "children": useViews("src/apps/app_view.nexy"),
        })

See Layouts.

Example

See examples/Modular/api/minimal/.

Next steps

• Dependency injection: services and scopes
• Guards and metadata: protect and document routes
• Routing: the file-based router
• Config: every option, including useRouter

Copy page as Markdown Edit on GitHub