GitHubReceba novidades do Hedhog no seu e-mail
Novos lançamentos, receitas e breaking changes — sem spam.
Submódulo Core
route
Gerencia o registro de rotas HTTP/MCP e as associações de permissão.
Caminho de origem: libraries/core/src/route
Arquivo do módulo: route.module.ts
Introdução
Esta página documenta o submódulo route como parte do pacote Core. Use-a como referência técnica rápida para escopo de implementação, APIs expostas e pontos de integração MCP.
Endpoints HTTP
9 endpoints
Lista todas as rotas registradas com paginação.
- Query
- page, pageSize, search
Obtém uma rota pelo ID.
- Params
- routeId (int)
Registra uma nova rota.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| url | string | no | — |
| method | "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD" | no | — |
| type | "HTTP" | "MCP" | no | — |
| tool_name | string | no | MCP tool name when type is MCP |
| name | string | no | — |
Atualiza uma rota existente.
- Params
- routeId (int)
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| url | string | no | — |
| method | "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD" | no | — |
| type | "HTTP" | "MCP" | no | — |
| tool_name | string | no | — |
| name | string | no | — |
Exclui uma ou mais rotas.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| ids | number[] | yes | IDs to delete |
Lista as roles que têm acesso a uma rota.
- Params
- routeId (int)
- Query
- page, pageSize
Substitui as permissões de role de uma rota.
- Params
- routeId (int)
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| ids | number[] | yes | Replacement set of IDs |
Lista as screens associadas a uma rota.
- Params
- routeId (int)
- Query
- page, pageSize
Substitui as associações de screen de uma rota.
- Params
- routeId (int)
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| ids | number[] | yes | Replacement set of IDs |
Ferramentas MCP
Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).
core.routes.listLista todas as rotas registradas com paginação
core.routes.getObtém uma rota pelo ID
core.routes.createRegistra uma nova rota HTTP ou MCP
core.routes.updateAtualiza uma rota existente
core.routes.deleteExclui uma ou mais rotas
core.routes.roles.listLista as roles que têm acesso a uma rota
core.routes.roles.updateSubstitui as permissões de role de uma rota
core.routes.screens.listLista as screens associadas a uma rota
core.routes.screens.updateSubstitui as associações de screen de uma rota