Benutzerfreundlicher Prüfungsname

Was ist ein benutzerfreundlicher Prüfungsname?

Ein benutzerfreundlicher Prüfungsname ist eine leicht lesbare Bezeichnung für Ihre API-Prüfung. Er hilft Ihnen, den Zweck und Kontext der Prüfung schnell zu verstehen, ohne sich technische Details merken oder nachschlagen zu müssen. Der Name wird in Warnungen und Berichten verwendet, was die Verwaltung und Referenzierung Ihrer Prüfungen erleichtert.

Automatisch generierte Namen

Wenn Sie die URL einer API-Prüfung eingeben, füllt LoadFocus den Namen aus dieser URL für Sie aus: den Domainnamen, plus den Pfad, falls es einen gibt. Zum Beispiel wird aus https://api.example.com/users der Name Example - Users. Sie können ihn bearbeiten, um einen aussagekräftigeren Namen zu setzen. Bei anderen Prüfungstypen ohne URL tippen Sie den Namen selbst ein.

So ändern Sie den benutzerfreundlichen Prüfungsnamen

Sie können den Namen Ihrer API-Prüfung ändern, indem Sie zum Eingabefeld Freundlicher Prüfungsname gehen und Ihren eigenen Namen festlegen. Ein Name ist erforderlich. Er wird in Warnungen und Berichten verwendet, und Warnungs-E-Mails tragen ihn im Betreff, zum Beispiel [LoadFocus] Failure Alert Triggered for User Login Endpoint - San Francisco.

Best Practices für die Benennung von API-Prüfungen

1. Beschreibend und klar: Verwenden Sie klare und beschreibende Namen, die genug Kontext darüber geben, was die Prüfung testet. Vermeiden Sie übertechnische Namen, die verwirrend sein könnten.

• Beispiel: User Login Endpoint - San Francisco

2. Endpunkt und Standort einbeziehen: Wenn Sie denselben Endpunkt von mehreren Standorten aus testen, fügen Sie den Standort in den Namen ein, um sie zu unterscheiden.

• Beispiel: Product Search API - US East

3. Konsistente Namenskonventionen verwenden: Etablieren und befolgen Sie eine konsistente Namenskonvention, um das Suchen und Filtern Ihrer Prüfungen zu erleichtern.

• Beispiel: Dienstname - Endpunkt - Standort
• Beispiel: Inventory Service - Add Item - EU Central

4. Zweck oder Szenario angeben: Wenn die Prüfung für einen bestimmten Zweck oder ein bestimmtes Szenario ist, fügen Sie dies in den Namen ein.

• Beispiel: Payment API - Load Test - High Volume

5. Kurz und prägnant: Halten Sie den Namen knapp, aber informativ. Vermeiden Sie überlange Namen, die abgeschnitten oder schwer schnell zu lesen sein könnten.

• Beispiel: Checkout API - Latency Check

Beispiele für benutzerfreundliche Prüfungsnamen

• 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

Vorteile der Verwendung benutzerfreundlicher Prüfungsnamen

• Verbesserte Verwaltbarkeit: Identifizieren und verwalten Sie Ihre API-Prüfungen einfach.
• Bessere Warnungen: Erhalten Sie Warnungen mit aussagekräftigen Namen, die das Verständnis des Problemkontexts erleichtern.
• Verbesserte Zusammenarbeit: Teammitglieder können den Zweck jeder Prüfung schnell verstehen, was eine bessere Zusammenarbeit und Kommunikation fördert.

Tags

Neben dem Namen können Sie Tags hinzufügen: optionale Kennzeichnungen wie produktion oder zahlungen, durch Kommas getrennt, bis zu 10 pro Prüfung und je 30 Zeichen (Buchstaben, Ziffern, Leerzeichen, Punkte, Unterstriche und Bindestriche). Groß- und Kleinschreibung wird nicht unterschieden, Duplikate werden verworfen.

Tags erscheinen als kleine Marken neben der Prüfung in der Prüfungsliste. Klicken Sie auf eine Marke, um nur die Prüfungen mit diesem Tag anzuzeigen, und leeren Sie das Filterfeld, um wieder alle Prüfungen zu sehen. Tags sind auch Teil von Monitoring as Code: Eine Prüfungsdatei setzt sie mit einer tags-Liste, und das Deployment einer Datei ohne tags entfernt sie von dieser Prüfung.