Benutzerfreundlicher Prüfungsname

API-Prüfung 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

Wir generieren automatisch einen benutzerfreundlichen Prüfungsnamen für Ihre API-Prüfung unter Verwendung des aktuellen Datums und der Uhrzeit. Der Name wird automatisch aus der URL vervollständigt, um Ihnen einen schnellen Kontext des getesteten Endpunkts zu geben. Sie können ihn jedoch manuell bearbeiten, um einen aussagekräftigeren und bedeutungsvolleren Namen festzulegen.

So ändern Sie den benutzerfreundlichen Prüfungsnamen

Sie können den benutzerfreundlichen Prüfungsnamen für Ihre API-Prüfung ändern, indem Sie zum Eingabefeld für den Prüfungsnamen gehen und Ihren eigenen Namen festlegen. Dieser angepasste Name wird dann in Warnungen und Berichten verwendet.

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

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

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

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

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

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.

Indem Sie diese Best Practices befolgen und beschreibende, klare und konsistente benutzerfreundliche Prüfungsnamen verwenden, können Sie die Verwaltbarkeit und Effektivität Ihrer API-Prüfungen erheblich verbessern.