No Apidog, todos os endpoints suportam comentários, permitindo que os membros da equipa discutam e colaborem diretamente na documentação do endpoint.Abrir Comentários#
Para ver ou adicionar comentários, basta abrir qualquer endpoint e clicar no ícone "Comentários" no canto superior direito. O painel de comentários deslizará a partir da lateral da página, facilitando a consulta de discussões existentes ou a publicação de novo feedback.Nos comentários, pode utilizar @ para mencionar membros do projeto. Depois de publicado, os membros mencionados receberão uma notificação, incluindo por email e na caixa de entrada.As notificações por email e na caixa de entrada têm de estar ativadas em Definições > Notificações (canto superior direito). Caso contrário, os membros não receberão alertas relacionados.
Exemplo de Notificação por Email#
Exemplo de Notificação na Caixa de Entrada#
Utilizar a funcionalidade de menção com @ de forma criteriosa garante que os membros da equipa são alertados prontamente sobre questões importantes. Atualmente, as notificações suportam apenas email e caixa de entrada — canais de terceiros, como Slack ou Teams, não são suportados.Suporte para Carregamento de Imagens#
Pode inserir imagens diretamente nos comentários para fornecer detalhes adicionais, tais como exemplos de pedidos, capturas de ecrã ou registos de erro.Como carregar: clique no ícone de imagem na caixa de introdução de comentários e selecione uma imagem local, ou simplesmente copie e cole a imagem na caixa de introdução. Pode clicar nas imagens para as ampliar.Filtragem de Comentários#
Quando houver muitos comentários, utilize a funcionalidade de filtro para encontrar rapidamente o que precisa:Aberto: mostra apenas comentários que ainda não foram tratados.
Resolvido: mostra comentários marcados como resolvidos, facilitando a revisão de discussões anteriores.
Durante a colaboração em equipa, certifique-se de que marca as questões como "Resolvido" prontamente para manter a lista de comentários organizada e clara.