API-endpointnamnsgenerator
Använd den här generatorn när en API-rutt behöver ett namn som en lagkamrat kan förstå med en snabb blick. Den använder REST-resurser, administratörsomfång, webhooks, exporter, uppladdningar, sökningar, jobb och statusetiketter utan att göra dem till dekorativ text.
Senast uppdaterad:
Resultat
Tidigare resultat 0
Skarpare etiketter för API-ytor
Namngivning av slutpunkter är ett litet val som sprider sig överallt: specifikationer, styrenheter, loggar, runbooks, SDK-omslag och supportanteckningar. Generatorn ger dig praktiska namn för verb-resursnamn, kapslade underresursvägar, webhook-återanropsvägar, analysexportvägar, uppladdnings- och medieslutpunkter, hälsokontroll- och statusslutpunkter samt farliga destruktiva handlingsvägar.
Använd ett resultat som ett namngivningsutkast, inte som en regel du måste acceptera. Behåll resursen som känns rätt, justera verbet så att det matchar det verkliga beteendet och gör omfånget synligt. Administratörsvägar ska låta begränsade. Offentliga skrivskyddade vägar ska låta säkra att anropa. Utlösarvägar för bakgrundsjobb ska låta som köat arbete. Resultat från lukter från äldre monolitnamn kan vara användbara varningar när ett ruttnamn döljer sig för mycket.
Frågor innan du behåller ett
- Skulle detta namn överleva i en OpenAPI-sammanfattning?
- Avslöjar det om rutten läser, muterar, tar bort, köar eller tar emot?
- Kan angränsande rutter återanvända samma mönster utan att bli vagt?
- Hjälper namnet någon att felsöka slutpunkten från en loggrad?
Vanliga frågor
Får jag använda resultaten gratis?
Ja. Du får använda resultaten gratis i berättelser, spel och andra projekt.
Hur många gånger kan jag generera resultat?
Du kan slå tärningarna så ofta du vill. Enskilda resultat kan dyka upp igen.
Behöver jag en internetanslutning?
Ja. Generatorn behöver en internetanslutning för att läsa in resultaten.
Var hittar jag fler verktyg för berättare?
Se API-endpointnamnsgenerator på The Story Shack för fler idéer och skrivverktyg.