Webfejlesztés

Öt gyakori API-tervezési hiba és a javításuk

Kiszámíthatatlan hibák, instabil mezők és hiányzó idempotencia teszik törékennyé az integrációt.

Szerződés

Az API válaszformája legyen dokumentált és verziózható. A hibák egységes kódot, emberi leírást és szükség esetén mezőszintű részletet kapjanak.

Ismételt kérés

Fizetésnél, rendelésnél vagy importnál számolni kell az újraküldéssel. Idempotenciakulcs nélkül ugyanaz a kérés többször hozhat létre rekordot.

Változtatás

Új mező általában kompatibilis, meglévő jelentésének változtatása nem. A fogyasztókkal szerződéses teszt vagy legalább staging ellenőrzés szükséges.