En Apidog, cada endpoint admite comentarios, lo que permite a los miembros del equipo debatir y colaborar directamente en la documentación del endpoint.Abrir comentarios#
Para ver o añadir comentarios, simplemente abra cualquier endpoint y haga clic en el icono "Comentarios" en la esquina superior derecha. El panel de comentarios se deslizará desde el lateral de la página, lo que facilita consultar las conversaciones existentes o publicar nuevos comentarios.Añadir comentarios y menciones con @#
En los comentarios, puede usar @ para mencionar a miembros del proyecto. Una vez publicado, los miembros mencionados recibirán una notificación, incluidas notificaciones por correo electrónico y en la bandeja de entrada.Las notificaciones por correo electrónico y en la bandeja de entrada deben estar habilitadas en Configuración > Notificaciones (esquina superior derecha). De lo contrario, los miembros no recibirán las alertas relacionadas.
Ejemplo de notificación por correo electrónico#
Ejemplo de notificación en la bandeja de entrada#
Usar la función de mención @ de forma adecuada garantiza que los miembros del equipo reciban alertas rápidamente sobre asuntos importantes. Actualmente, las notificaciones solo admiten correo electrónico y bandeja de entrada; no se admiten canales de terceros como Slack o Teams.Compatibilidad con la carga de imágenes#
Puede insertar imágenes directamente en los comentarios para proporcionar detalles adicionales, como ejemplos de petición, capturas de pantalla o registros de errores.Cómo cargar: Haga clic en el icono de imagen en el cuadro de entrada de comentarios y seleccione una imagen local, o simplemente copie y pegue la imagen en el cuadro de entrada. Se puede hacer clic en las imágenes para ampliarlas.Filtrado de comentarios#
Cuando haya muchos comentarios, use la función de filtro para encontrar rápidamente lo que necesita:Abierto: Muestra solo los comentarios que aún no se han abordado.
Resuelto: Muestra los comentarios marcados como resueltos, lo que facilita revisar conversaciones anteriores.
Durante la colaboración en equipo, asegúrese de marcar los asuntos como "Resuelto" de inmediato para mantener la lista de comentarios organizada y clara.