API-endepunktnavngenerator
Bruk denne generatoren når en API-rute trenger et navn som en lagkamerat kan forstå med et øyeblikk. Den bruker REST-ressurser, administratorområder, webhooks, eksport, opplastinger, søk, jobber og statusetiketter uten å gjøre dem om til dekorativ tekst.
Sist oppdatert:
Resultater
Tidligere resultater 0
Skarpere etiketter for API-overflater
Navngiving av endepunkter er et lite valg som sprer seg overalt: spesifikasjoner, kontrollere, logger, runbooks, SDK-wrappers og støttenotater. Generatoren gir deg praktiske navn på tvers av navn på verb-ressurser, nestede underressursruter, webhook-tilbakekallsstier, eksportruter for analyse, opplastings- og medieendepunkter, helsesjekk- og statusendepunkter og farlige destruktive handlingsstier.
Bruk et resultat som et navngivingsutkast, ikke som en regel du må godta. Behold ressursen som føles riktig, juster verbet slik at det samsvarer med den faktiske oppførselen, og gjør omfanget synlig. Administratorruter bør høres begrensede ut. Offentlige skrivebeskyttede ruter bør høres trygge ut å kalle. Utløserruter for bakgrunnsjobber bør høres ut som arbeid i kø. Luktresultater fra eldre monolittnavn kan være nyttige advarsler når et rutenavn skjuler seg for mye.
Spørsmål før du beholder et
- Ville dette navnet overleve i et OpenAPI-sammendrag?
- Avslører det om ruten leser, muterer, sletter, setter i kø eller mottar?
- Kan nærliggende ruter gjenbruke det samme mønsteret uten å bli vagt?
- Hjelper navnet noen med å feilsøke endepunktet fra en logglinje?
Ofte stilte spørsmål
Kan jeg bruke resultatene gratis?
Ja. Du kan bruke resultatene gratis i fortellinger, spill og andre prosjekter.
Hvor mange ganger kan jeg få nye resultater?
Du kan kaste terningene så ofte du vil. Noen resultater kan dukke opp igjen.
Må jeg være koblet til internett?
Ja. Generatoren trenger en internettforbindelse for å laste inn resultatene.
Hvor finner jeg flere verktøy for fortellere?
Se API-endepunktnavngenerator på The Story Shack for flere ideer og skriveverktøy.