Nazwij powierzchnie kontraktu
Kontrakt API to wiecej niz OpenAPI. Obejmuje status codes, paginacje, autoryzacje, idempotencje, ksztalt bledow, rate limits i zasady zycia endpointu.
Kompatybilnosc to obietnica produktowa
Konsumenta nie obchodzi, ze pole bylo wygodnie przemianowac. Obchodzi go, czy integracja nadal dziala. Polityka breaking change musi byc jawna.
{
"error": "validation_failed",
"traceId": "00-...",
"fields": {
"email": ["must be a valid email address"]
}
}
Utrzymaj mala macierz testow
| Obszar | Check kontraktu |
|---|---|
| Ksztalt bledu | Snapshot przykladowych odpowiedzi |
| Paginacja | Pusta, pierwsza, srodkowa, ostatnia strona |
| Idempotencja | Retry tworzy jeden efekt |