API-endpoint-nimigeneraattori
Käytä tätä generaattoria, kun API-reitti tarvitsee nimen, jonka tiimikaveri ymmärtää yhdellä silmäyksellä. Se hyödyntää REST-resursseja, järjestelmänvalvojan laajuuksia, webhookeja, vientiä, latausta, hakua, työpaikkoja ja tilatunnisteita muuttamatta niitä koristeelliseksi tekstiksi.
Viimeksi päivitetty:
Tulokset
Aiemmat tulokset 0
Terävämmät nimet API-pinnoille
Päätepisteiden nimeäminen on pieni valinta, joka leviää kaikkialle: spesifikaatioihin, ohjaimiin, lokeihin, runbookeihin, SDK-kääreisiin ja tukitiedoihin. Generaattori antaa sinulle käytännöllisiä nimiä verbiresurssien nimille, sisäkkäisille aliresurssien reiteille, webhook-takaisinkutsupoluille, analytiikan vientireiteille, lataus- ja mediapäätepisteille, kuntotarkastus- ja tilapäätepisteille sekä vaarallisille ja tuhoaville toimintopoluille.
Käytä tulosta nimeämisluonnoksena, älä sääntönä, joka sinun on hyväksyttävä. Pidä resurssi, joka tuntuu oikealta, säädä verbi vastaamaan todellista toimintaa ja tee laajuus näkyväksi. Ylläpitäjän reittien tulisi kuulostaa rajoitetuilta. Julkisten vain luku -reittien tulisi kuulostaa turvallisilta kutsua. Taustatyön käynnistysreittien tulisi kuulostaa jonossa olevalta työltä. Perinteisten monoliittien nimeämishajujen tulokset voivat olla hyödyllisiä varoituksia, kun reitin nimi piilottaa liikaa tietoa.
Kysymyksiä ennen nimen säilyttämistä
- Säilyisikö tämä nimi OpenAPI-yhteenvedossa?
- Paljastaako se, lukeeko, mutatoiko, poistaako, asettaako vai vastaanottaako reitti tietoja?
- Voivatko naapurireitit käyttää samaa mallia uudelleen ilman, että siitä tulee epämääräinen?
- Auttaako nimi päätepisteen virheenkorjauksessa lokiriviltä?
Usein kysytyt kysymykset
Voinko käyttää tuloksia ilmaiseksi?
Kyllä. Voit käyttää tuloksia ilmaiseksi tarinoissa, peleissä ja muissa projekteissa.
Kuinka monta kertaa voin arpoa tuloksia?
Voit arpoa tuloksia niin monta kertaa kuin haluat. Sama tulos voi tulla vastaan useammin kuin kerran.
Tarvitsenko internetyhteyden?
Kyllä. Generaattori tarvitsee internetyhteyden tulosten lataamiseen.
Mistä löydän lisää työkaluja tarinankerrontaan?
Kokeile työkalua API-endpoint-nimigeneraattori The Story Shackissa ja löydä lisää ideoita ja kirjoitustyökaluja.