Přátelský název kontroly

Přátelský název API kontroly

Co je přátelský název kontroly?

Přátelský název kontroly je lidsky čitelný identifikátor vaší API kontroly. Pomáhá vám rychle pochopit účel a kontext kontroly bez nutnosti pamatovat si nebo vyhledávat technické detaily. Název se používá v upozorněních a reportech, což usnadňuje správu a referenci vašich kontrol.

Automaticky generované názvy

Automaticky generujeme přátelský název kontroly pro vaši API kontrolu pomocí aktuálního data a času. Název se automaticky doplní z URL, aby vám poskytl rychlý kontext o testovaném endpointu. Můžete jej však ručně upravit a nastavit popisnější a smysluplnější název.

Jak změnit přátelský název kontroly

Přátelský název kontroly pro vaši API kontrolu můžete změnit tak, že přejdete do vstupního pole Přátelský název kontroly a nastavíte svůj vlastní název. Tento přizpůsobený název se poté bude používat v upozorněních a reportech.

Osvědčené postupy pro pojmenování API kontrol

Popisný a jasný: Používejte jasné a popisné názvy, které poskytují dostatečný kontext o tom, co kontrola testuje. Vyhněte se příliš technickým názvům, které mohou být matoucí.

Příklad: User Login Endpoint - San Francisco

Zahrňte endpoint a lokaci: Pokud testujete stejný endpoint z více lokací, zahrňte lokaci do názvu pro jejich odlišení.

Příklad: Product Search API - US East

Používejte konzistentní konvence pojmenování: Stanovte a dodržujte konzistentní konvenci pojmenování pro snazší vyhledávání a filtrování kontrol.

Příklad: NázevSlužby - Endpoint - Lokace
Příklad: Inventory Service - Add Item - EU Central

Uveďte účel nebo scénář: Pokud je kontrola pro konkrétní účel nebo scénář, zahrňte to do názvu.

Příklad: Payment API - Load Test - High Volume

Krátký a výstižný: Udržujte název stručný, ale informativní. Vyhněte se příliš dlouhým názvům, které mohou být zkráceny nebo obtížně čitelné.

Příklad: Checkout API - Latency Check

Příklady přátelských názvů kontrol

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

Výhody používání přátelských názvů kontrol

Lepší správa: Snadno identifikujte a spravujte vaše API kontroly.
Lepší upozornění: Přijímejte upozornění se smysluplnými názvy, což usnadňuje pochopení kontextu problému.
Vylepšená spolupráce: Členové týmu mohou rychle pochopit účel každé kontroly, což usnadňuje lepší spolupráci a komunikaci.

Dodržováním těchto osvědčených postupů a používáním popisných, jasných a konzistentních přátelských názvů kontrol můžete výrazně zlepšit spravovatelnost a efektivitu vašich API kontrol.