Docs/Roteador modular

Roteamento modular

O roteamento modular usa classes com decoradores em vez de arquivos em src/routes/: os controladores tratam das solicitações, os módulos as agrupam e os provedores são injetados. Monte o APIRouter resultante com useRouter em nexyconfig.py.

Antes de começar: um projeto Nexy e uma página de trabalho. O roteador modular substitui o baseado em arquivo, então leia Roteamento primeiro se você ainda não escolheu um roteador.

Configure o roteador

from nexy.core.models import NexyConfigModelfrom src.apps.app_module import AppModule  class NexyConfig(NexyConfigModel):    useRouter = AppModule

Escreva um controlador

from nexy.decorators import Controllerfrom nexy.core.types import JsonResponse  @Controller()class AppController:    async def get(self) -> JsonResponse:        return {"message": "Welcome to Nexy Modular API"}

Os métodos são combinados por nome, sem distinção entre maiúsculas e minúsculas: get, post, put, patch, delete, options, head, trace.

Um controlador declara um manipulador por método HTTP; uma duplicata aumenta na inicialização. O primeiro argumento de @Controller("/users") é o caminho em que cada manipulador responde, /users/. async def SOCKET(...) em um controlador registra um WebSocket no mesmo caminho.

Agrupar controladores em um módulo

from nexy.decorators import Modulefrom .app_controller import AppController  @Module()class AppModule:    controllers = [AppController]

@Module(prefix="/api") retorna um APIRouter. controllers é obrigatório; providers, imports e exports são opcionais. Os módulos importados são montados como subroteadores e seus provedores exportados são resolvidos na inicialização.

Visualizações de um controlador

Um controlador pode retornar uma página. useViews renderiza uma visualização .nexy; aninhe um dentro do outro para envolvê-lo em um layout:

from nexy.decorators import Controllerfrom 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"),        })

Consulte Layouts.

Exemplo

Veja examples/Modular/api/minimal/.

Próximas etapas

• Injeção de dependência: serviços e escopos
• Guardas e metadados: proteger e documentar rotas
• Roteamento: o roteador baseado em arquivo
• Configuração: todas as opções, incluindo useRouter

Copiar a página como Markdown Editar no GitHub