Opisz wymianę
Dla każdej operacji udokumentuj metodę, zasób, wymagane pola oraz kształt prawidłowej odpowiedzi. Dołącz błąd walidacji. Rozróżnij awarię transportu od odrzuconego żądania: brak odpowiedzi nie dowodzi, że operacja zmieniająca stan nie powiodła się.
Traktuj dane uwierzytelniające jako konfigurację
Przechowuj dane uwierzytelniające serwera poza pakietami przeglądarkowymi i repozytoriami źródłowymi. Żądaj najmniejszego przydatnego zestawu uprawnień i oddziel dostęp deweloperski od produkcyjnego. Zapisz, kto jest właścicielem każdej integracji i w jaki sposób można odwołać dostęp. Postępuj zgodnie z udokumentowanym procesem autoryzacji dostawcy.
Planuj sytuacje, gdy zależności będą niedostępne
Ustaw limity czasu, przestrzegaj wytycznych dotyczących ograniczeń liczby żądań i ponawiaj próby tylko wtedy, gdy operacja może być bezpiecznie powtórzona. Tam, gdzie jest to obsługiwane, klucz idempotentności może identyfikować powtarzane żądania. Zaloguj identyfikator żądania i zwięzłą kategorię błędu; unikaj nagłówków autoryzacji, ciasteczek sesyjnych i danych osobowych.