No Apidog, todos os endpoints oferecem suporte a comentários, permitindo que os membros da equipe discutam e colaborem diretamente na documentação do endpoint.Abrindo comentários#
Para visualizar ou adicionar comentários, basta abrir qualquer endpoint e clicar no ícone "Comentários" no canto superior direito. O painel de comentários será exibido a partir da lateral da página, facilitando a verificação de discussões existentes ou a publicação de novos feedbacks.Nos comentários, você pode usar @ para mencionar membros do projeto. Depois que o comentário for publicado, os membros mencionados receberão uma notificação, incluindo email e caixa de entrada.As notificações por email e na caixa de entrada precisam estar ativadas em Configurações > Notificações (canto superior direito). Caso contrário, os membros não receberão os alertas relacionados.
Exemplo de notificação por email#
Exemplo de notificação na caixa de entrada#
Usar o recurso de menção com @ de forma adequada garante que os membros da equipe sejam alertados rapidamente sobre questões importantes. Atualmente, as notificações são compatíveis apenas com email e caixa de entrada — canais de terceiros, como Slack ou Teams, não são compatíveis.Suporte ao upload de imagens#
Você pode inserir imagens diretamente nos comentários para fornecer detalhes adicionais, como exemplos de requisição, capturas de tela ou logs de erro.Como fazer upload: Clique no ícone de imagem na caixa de entrada de comentários e selecione uma imagem local, ou simplesmente copie e cole a imagem na caixa de entrada. As imagens podem ser clicadas para ampliar.Filtragem de comentários#
Quando houver muitos comentários, use o recurso de filtro para encontrar rapidamente o que você 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 equipe, certifique-se de marcar os problemas como "Resolvido" prontamente para manter a lista de comentários organizada e clara.