Logotipo Hedhog

Receba novidades do Hedhog no seu e-mail

Novos lançamentos, receitas e breaking changes — sem spam.

Voltar para os módulos CoreIntegrado no CoreModule

Submódulo Core

menu

Constrói árvores de menu e vínculos de role para a navegação.

Caminho de origem: libraries/core/src/menu

Arquivo do módulo: menu.module.ts

Introdução

Esta página documenta o submódulo menu 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

13 endpoints

Retorna a árvore de menu de navegação do usuário atual.

Retorna estatísticas agregadas sobre o catálogo de menus.

Retorna uma lista simples de todos os menus no locale informado.

Query
locale? (string)

Lista os menus com paginação.

Query
page, pageSize, search

Obtém uma entrada de menu pelo ID.

Params
menuId (int)

Lista as roles associadas a uma entrada de menu.

Params
menuId (int)
Query
page, pageSize

Lista as screens associadas a uma entrada de menu.

Params
menuId (int)
Query
page, pageSize

Cria uma nova entrada de menu.

Body

FieldTypeRequiredNotes
slugstringyes—
urlstringyes—
ordernumbernoMin 1
iconstringno—
menu_idnumbernoParent menu ID, min 1
localeRecord<string, string>noLabel translations

Atualiza a ordem de exibição de várias entradas de menu.

Body

FieldTypeRequiredNotes
idsnumber[]yesMenu IDs in desired order; ArrayMinSize(1)

Atualiza uma entrada de menu.

Params
menuId (int)

Body

FieldTypeRequiredNotes
namestringno—
urlstringno—
ordernumberno—
iconstringno—
menu_idnumbernoParent menu ID
localeRecord<string, string>no—

Substitui as atribuições de role de uma entrada de menu.

Params
menuId (int)

Body

FieldTypeRequiredNotes
idsnumber[]yesReplacement set of IDs

Substitui as atribuições de screen de uma entrada de menu.

Params
menuId (int)

Body

FieldTypeRequiredNotes
idsnumber[]yesReplacement set of IDs

Exclui uma ou mais entradas de menu.

Body

FieldTypeRequiredNotes
idsnumber[]yesIDs to delete

Ferramentas MCP

Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).

  • core.menus.system

    Retorna a árvore de menu de navegação do usuário atual

  • core.menus.stats

    Retorna estatísticas agregadas sobre o catálogo de menus

  • core.menus.all

    Retorna uma lista simples de todos os menus em um locale informado

  • core.menus.list

    Lista os menus com paginação

  • core.menus.get

    Obtém uma entrada de menu pelo ID

  • core.menus.create

    Cria uma nova entrada de menu com slug, URL, ordem, ícone e traduções

  • core.menus.update

    Atualiza as propriedades de uma entrada de menu

  • core.menus.delete

    Exclui uma ou mais entradas de menu

  • core.menus.order

    Atualiza a ordem de exibição de várias entradas de menu

  • core.menus.roles.list

    Lista as roles associadas a uma entrada de menu

  • core.menus.roles.update

    Substitui as atribuições de role de uma entrada de menu