Nombre Amigable de Verificación

Nombre Amigable de Verificación de API

¿Qué es un Nombre Amigable de Verificación?

Un nombre amigable de verificación es un identificador legible para tu verificación de API. Te ayuda a comprender rápidamente el propósito y contexto de la verificación sin necesidad de recordar o buscar detalles técnicos. El nombre se usa en alertas e informes, facilitando la gestión y referencia de tus verificaciones.

Nombres Generados Automáticamente

Generamos automáticamente un nombre amigable para tu verificación de API usando la fecha y hora actuales. El nombre se autocompletará a partir de la URL para darte un contexto rápido del endpoint que se está probando. Sin embargo, puedes editarlo manualmente para establecer un nombre más descriptivo y significativo.

Cómo Cambiar el Nombre Amigable de Verificación

Puedes cambiar el nombre amigable de tu verificación de API yendo al campo de entrada de Nombre Amigable de Verificación y estableciendo tu propio nombre. Este nombre personalizado se usará entonces en alertas e informes.

Mejores Prácticas para Nombrar Verificaciones de API

1. Descriptivo y Claro: Usa nombres claros y descriptivos que proporcionen suficiente contexto sobre lo que la verificación está probando. Evita nombres excesivamente técnicos que puedan ser confusos.

• Ejemplo: User Login Endpoint - San Francisco

2. Incluir Endpoint y Ubicación: Si estás probando el mismo endpoint desde múltiples ubicaciones, incluye la ubicación en el nombre para diferenciarlos.

• Ejemplo: Product Search API - US East

3. Usar Convenciones de Nomenclatura Consistentes: Establece y sigue una convención de nomenclatura consistente para facilitar la búsqueda y filtrado de tus verificaciones.

• Ejemplo: NombreServicio - Endpoint - Ubicación
• Ejemplo: Inventory Service - Add Item - EU Central

4. Indicar Propósito o Escenario: Si la verificación es para un propósito o escenario específico, inclúyelo en el nombre.

• Ejemplo: Payment API - Load Test - High Volume

5. Corto y Conciso: Mantén el nombre conciso pero informativo. Evita nombres excesivamente largos que puedan truncarse o ser difíciles de leer rápidamente.

• Ejemplo: Checkout API - Latency Check

Ejemplos de Nombres Amigables de Verificación

• User Authentication API - London
• Order Processing - Peak Hours - Asia
• Search Service - Keyword Search - US West
• User Profile Update - Response Time
• Cart API - Add Item - Canada
• Notification Service - Delivery Status - Australia

Beneficios de Usar Nombres Amigables de Verificación

• Mejor Gestión: Identifica y gestiona fácilmente tus verificaciones de API.
• Mejores Alertas: Recibe alertas con nombres significativos, facilitando la comprensión del contexto del problema.
• Colaboración Mejorada: Los miembros del equipo pueden comprender rápidamente el propósito de cada verificación, facilitando una mejor colaboración y comunicación.

Siguiendo estas mejores prácticas y usando nombres amigables descriptivos, claros y consistentes, puedes mejorar significativamente la gestión y efectividad de tus verificaciones de API.