Skip to content

Registro automático de rotas ​

Em um projeto de API, o entrypoint do Tyrus descobre recursivamente os módulos de rota dentro de src/routes/. Cada módulo pode exportar uma ou mais funções com a assinatura (router: HttpRouter) => void; o Tyrus chama cada função com o router da aplicação quando createRouter() é executado, antes de o servidor iniciar a escuta. O export default continua compatível. Não é necessário criar index.tyr nem importar cada rota.

src/routes/health.tyr ​

typescript
import { HttpReply, HttpRouter, HttpStatus } from "tyrus:http";

interface HealthResponse {
    status: string;
}

export const healthRoutes = (router: HttpRouter): void => {
    router.get("/health", {
        response: { 200: HealthResponse },
        handler: (_request: {}, reply: HttpReply<HealthResponse>): void => {
            reply.status(HttpStatus.Ok).send({ status: "ok" });
        },
    });
};

src/main.tyr ​

typescript
import { createRouter, HttpRouter } from "tyrus:http";

const app: HttpRouter = createRouter();
app.listen(3000);

Discovery rules ​

Um arquivo .tyr em src/routes/ sem uma função exportada que corresponda à assinatura de rota é tratado como módulo auxiliar e não é chamado. Um export default nessa pasta precisa corresponder à assinatura de plugin de rota ou o projeto falha ao carregar. Arquivos terminados em .test.tyr ficam fora da descoberta.

Exports fora de src/routes/ nunca são registrados automaticamente. Importe e chame esses módulos explicitamente quando necessário.