Zmiany w API
Zmiany łamiące zgodność, wycofywanie i wersjonowanie, przekazane osobom, których dotyczą.
-
Wersjonowanie API Stripe: jak działa i co z niego skopiować
Wersjonowanie API Stripe przypina każde konto do wersji z datą i pozwala nadpisać ją w żądaniu. Jak działa, ile kosztuje i co może skopiować małe API.
Zmiany w API6 min czytania
-
Zmiany łamiące w Protobuf: co przetrwa na wire
Zmiany łamiące w Protobuf dzieją się na wire, nie w URL. Część zmian pól gRPC jest darmowa, inne po cichu łamią klientów, a w diffie wyglądają tak samo.
Zmiany w API5 min czytania
-
Deprecacja GraphQL bez numeru wersji
GraphQL nie ma v1 ani v2 w URL-u. Pola są deprecjonowane jedno po drugim dyrektywą, na jednym wspólnym schemacie, co zmienia, co jest winien changelog.
Zmiany w API5 min czytania
-
Jak napisać przewodnik migracji API
Przewodnik migracji API zamienia niekompatybilną zmianę w listę kontrolną zamiast awarii. Czego potrzebuje, kiedy go publikować i czemu wpis nie wystarczy.
Zmiany w API4 min czytania
-
Wewnętrzne changelogi API: co się zmienia dla innego zespołu
Publiczny changelog API ma odbiorców, do których nie da się dotrzeć bezpośrednio. Wewnętrzny ma odbiorców dwa piętra dalej, i to zmienia, co się im należy.
Zmiany w API5 min czytania
-
Changelogi webhooków: zmiana łamiąca bez prośby
Zmiana payloadu webhooka psuje się po cichu, bo nikt nie może jej odrzucić. Co czyni zmianę payloadu łamiącą, i jak nadać jej wersję krok po kroku.
Zmiany w API5 min czytania
-
Nagłówek Sunset w API i kiedy go wysyłać
Nagłówek Sunset w API mówi klientowi, kiedy wersja przestanie odpowiadać, inaczej niż powiadomienie o deprecacji. Co obejmuje RFC 8594 i co daje brownout.
Zmiany w API5 min czytania
-
Changelog API: co publikować i kto to czyta
Changelog API czytają osoby decydujące, czy ich kod będzie działał za miesiąc. Co każdy wpis im zawdzięcza, gdzie mieszka i jak się subskrybuje.
Zmiany w API6 min czytania
-
Jak deprecjonować API, nie tracąc programistów
Deprecacja to obietnica z datą. Harmonogram, szablon powiadomienia, nagłówki odpowiedzi, i krok, który powstrzymuje sunset przed staniem się incydentem.
Zmiany w API5 min czytania
-
Najlepsze praktyki wersjonowania API, dla wywołujących
Wersjonujcie tylko to, co łamie kompatybilność, umieśćcie wersję tam, gdzie ją widzą wywołujący, i trzymajcie starą do daty. Cztery schematy porównane.
Zmiany w API6 min czytania
-
Zmiany łamiące kompatybilność: co się liczy i jak je wydać
Zmiana łamiąca kompatybilność to każda, której poprawny wywołujący by nie przetrwał. Co się liczy, co nie, jak ją wykryć w CI i bezpiecznie wydać.
Zmiany w API8 min czytania
