Vänligt kontrollnamn

Vänligt kontrollnamn för API-kontroll

Vad är ett vänligt kontrollnamn?

Ett vänligt kontrollnamn är en lättläst identifierare för din API-kontroll. Det hjälper dig att snabbt förstå syftet och sammanhanget för kontrollen utan att behöva komma ihåg eller slå upp tekniska detaljer. Namnet används i varningar och rapporter, vilket gör det enklare att hantera och referera till dina kontroller.

Automatiskt genererade namn

Vi genererar automatiskt ett vänligt kontrollnamn för din API-kontroll baserat på aktuellt datum och tid. Namnet fylls automatiskt i från URL:en för att ge dig snabb kontext om den endpoint som testas. Du kan dock redigera det manuellt för att ange ett mer beskrivande och meningsfullt namn.

Hur man ändrar det vänliga kontrollnamnet

Du kan ändra det vänliga kontrollnamnet för din API-kontroll genom att gå till inmatningsfältet för vänligt kontrollnamn och ange ditt eget namn. Detta anpassade namn används sedan i varningar och rapporter.

Bästa praxis för namngivning av API-kontroller

1. Beskrivande och tydligt: Använd tydliga och beskrivande namn som ger tillräckligt med kontext om vad kontrollen testar. Undvik alltför tekniska namn som kan vara förvirrande.

• Exempel: User Login Endpoint - San Francisco

2. Inkludera endpoint och plats: Om du testar samma endpoint från flera platser, inkludera platsen i namnet för att skilja dem åt.

• Exempel: Product Search API - US East

3. Använd konsekventa namnkonventioner: Etablera och följ en konsekvent namnkonvention för att göra det enklare att söka och filtrera dina kontroller.

• Exempel: ServiceName - Endpoint - Location
• Exempel: Inventory Service - Add Item - EU Central

4. Ange syfte eller scenario: Om kontrollen är för ett specifikt syfte eller scenario, inkludera det i namnet.

• Exempel: Payment API - Load Test - High Volume

5. Kort och koncist: Håll namnet kortfattat men informativt. Undvik alltför långa namn som kan trunkeras eller vara svåra att läsa snabbt.

• Exempel: Checkout API - Latency Check

Exempel på vänliga kontrollnamn

• 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

Fördelar med att använda vänliga kontrollnamn

• Förbättrad hanterbarhet: Identifiera och hantera dina API-kontroller enkelt.
• Bättre varningar: Ta emot varningar med meningsfulla namn, vilket gör det enklare att förstå sammanhanget för problemet.
• Förbättrat samarbete: Teammedlemmar kan snabbt förstå syftet med varje kontroll, vilket underlättar bättre samarbete och kommunikation.

Genom att följa dessa bästa praxis och använda beskrivande, tydliga och konsekventa vänliga kontrollnamn kan du avsevärt förbättra hanterbarheten och effektiviteten hos dina API-kontroller.