Nom convivial de la vérification

Nom convivial de la vérification API

Qu'est-ce qu'un nom convivial de vérification ?

Un nom convivial de vérification est un identifiant lisible par l'humain pour votre vérification API. Il vous aide à comprendre rapidement l'objectif et le contexte de la vérification sans avoir besoin de mémoriser ou de rechercher des détails techniques. Le nom est utilisé dans les alertes et les rapports, facilitant la gestion et le référencement de vos vérifications.

Noms générés automatiquement

Nous générons automatiquement un nom convivial pour votre vérification API en utilisant la date et l'heure actuelles. Le nom sera auto-complété à partir de l'URL pour vous donner un contexte rapide du point de terminaison testé. Cependant, vous pouvez le modifier manuellement pour définir un nom plus descriptif et significatif.

Comment changer le nom convivial de la vérification

Vous pouvez changer le nom convivial de votre vérification API en accédant au champ de saisie du nom convivial et en définissant votre propre nom. Ce nom personnalisé sera ensuite utilisé dans les alertes et les rapports.

Bonnes pratiques pour nommer les vérifications API

1. Descriptif et clair : Utilisez des noms clairs et descriptifs qui fournissent suffisamment de contexte sur ce que la vérification teste. Évitez les noms trop techniques qui pourraient être confus.

• Exemple : User Login Endpoint - San Francisco

2. Inclure le point de terminaison et l'emplacement : Si vous testez le même point de terminaison depuis plusieurs emplacements, incluez l'emplacement dans le nom pour les différencier.

• Exemple : Product Search API - US East

3. Utiliser des conventions de nommage cohérentes : Établissez et suivez une convention de nommage cohérente pour faciliter la recherche et le filtrage de vos vérifications.

• Exemple : NomService - PointTerminaison - Emplacement
• Exemple : Inventory Service - Add Item - EU Central

4. Indiquer l'objectif ou le scénario : Si la vérification est destinée à un objectif ou un scénario spécifique, incluez-le dans le nom.

• Exemple : Payment API - Load Test - High Volume

5. Court et concis : Gardez le nom concis mais informatif. Évitez les noms trop longs qui peuvent être tronqués ou difficiles à lire rapidement.

• Exemple : Checkout API - Latency Check

Exemples de noms conviviaux de vérification

• 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

Avantages de l'utilisation de noms conviviaux

• Meilleure gestion : Identifiez et gérez facilement vos vérifications API.
• Meilleures alertes : Recevez des alertes avec des noms significatifs, facilitant la compréhension du contexte du problème.
• Collaboration améliorée : Les membres de l'équipe peuvent rapidement comprendre l'objectif de chaque vérification, facilitant une meilleure collaboration et communication.

En suivant ces bonnes pratiques et en utilisant des noms conviviaux descriptifs, clairs et cohérents, vous pouvez améliorer considérablement la gestion et l'efficacité de vos vérifications API.