Keskitaso📝 Dokumentointi

API-virhevastausten yhtenäistys

Luo selkeä virhevastausstandardi API-rajapinnoille.

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

PR-kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio funktioille ja moduuleille niin, että IDE näyttää hyödylliset vihjeet. Kattaa parametrit, palautusarvot ja käyttöesimerkit.

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

Hyödyllisiä resursseja

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptit Kaikki kategoriat