API w JSON a API w XML

Wybór między JSON a XML mieści się w kontrakcie między klientem a API. Klient musi rozróżniać powodzenie, błędy walidacji i uwierzytelniania, przekroczone limity zapytań oraz tymczasowe błędy serwera. Format JSON czy XML nie zmienia semantyki HTTP, a adresy IPv4/IPv6 należy przechowywać bez zakładania długości typowej dla IPv4.

Jak obsłużyć odpowiedź

Sprawdzaj Content-Type, kod statusu, udokumentowane pola i limit wywołań. Kod HTTP 429 obsługuj osobno: respektuj Retry-After, jeśli się pojawi, i stosuj ograniczony wykładniczy backoff z jitterem. Zanim ponowisz żądanie, zastanów się, czy operacja jest idempotentna. W logach zapisuj identyfikatory żądań, status i opóźnienie – nigdy sekrety API.

Na co zwrócić uwagę

JSON naturalnie odwzorowuje typowe modele danych oparte na obiektach i tablicach i zwykle jest zwarty; XML obsługuje atrybuty, przestrzenie nazw i dojrzałe narzędzia do schematów. Wybieraj na podstawie kontraktu API i ekosystemu, zamiast zakładać, że jeden format jest zawsze szybszy lub bardziej poprawny. Aktualny kontrakt API i przykłady prawdziwych zapytań znajdziesz na stronie API 2IP.