Keskitaso📝 Dokumentointi

API-virhevastausten yhtenäistäminen

Luo selkeä virhevastausstandardi API-rajapinnoille.

Suora vastaus: mitä tämä sivu antaa?

  • Valmis promptimalli: voit kopioida sen sellaisenaan ja muokata muuttujat omaan tilanteeseen.
  • Nopea käyttöönotto: mukana on täytetty esimerkki ja selitys milloin promptia kannattaa käyttää.
  • Jos tarvitset työkalun käyttöohjeen: jatka Cursor-oppaisiin osoitteessa `/vibekoodaus/cursor`.

Prompti

Luo API-virhevastausstandardi seuraavalle palvelulle.

Nykyiset endpointit:
[ENDPOINTIT]

Nykyiset virheet:
[NYKYISET_VIRHEET]

Tuota:
1) Yhtenäinen virhevastausmuoto (JSON)
2) Virhekooditaulukko (koodi, merkitys, HTTP-status)
3) Ohje kehittäjälle: milloin mikä virhe palautetaan
4) Migratiosuunnitelma vanhasta formaatista uuteen

Kirjoita myös lyhyt README-osio tiimille.

Suomenkieliset vinkit

  • Pyydä aina myös migraatiostrategia, jotta muutos ei jää teoriaksi
  • Käytä taulukkomuotoa virhekoodeille nopean luettavuuden takia

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

  • [ENDPOINTIT]
  • [NYKYISET_VIRHEET]

Esimerkki

Täytetty prompti

Luo API-virhevastausstandardi seuraavalle palvelulle.

Nykyiset endpointit:
/api/orders, /api/payments, /api/users

Nykyiset virheet:
Osa palauttaa {error: "x"}, osa {message: "x"}, osa plain text

Tulos

Saat käyttövalmiin virheformaatin, joka vähentää integraatioiden kitkaa.

Vinkit

  • Sisällytä aina machine-readable virhekoodi
  • Pidä viesti sekä kehittäjälle että käyttäjälle ymmärrettävänä
  • Suunnittele migraatio, älä vain uusi formaatti

Milloin käyttää

  • API-virhevastausten laatu vaihtelee endpointtien välillä
  • Frontend-tiimi kärsii epäyhtenäisistä virheistä
  • Tarvitset dokumentoitavan standardin

Liittyvät promptit

Pull Request -kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

Aloittelija

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

Aloittelija

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

Aloittelija

Hyödyllisiä resursseja

Cursor-oppaat

Opi käyttämään prompteja Cursorissa tehokkaasti.

→

Projekti-ideat

Käytä prompteja omissa projekteissasi.

→

Sanasto

Opi vibekoodauksen terminologia.

→

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptitKaikki kategoriat