versioning-apis
Implement API versioning with backward compatibility, deprecation notices, and migration paths.\nUse when managing API versions and backward compatibility.\nTrigger with phrases like \
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Implement API versioning with backward compatibility, deprecation notices, and migration paths.\nUse when managing API versions and backward compatibility.\nTrigger with phrases like \
How to use
Przeanalizuj istniejące endpointy API za pomocą narzędzi Grep i Read, aby zidentyfikować obecne podejście do wersjonowania (jeśli istnieje) i skatalogować wszystkie publiczne endpointy wraz z ich kontraktami request/response.
Wybierz strategię wersjonowania na podstawie wzorców konsumentów API: wersjonowanie przez ścieżkę URL dla publicznych API, wersjonowanie przez nagłówki dla API wymagających czystych URL-i, lub negocjację zawartości dla zaawansowanych przypadków użycia.
Utwórz router wersji, który kieruje żądania do odpowiedniego zestawu handlerów wersji na podstawie identyfikatora wersji wyodrębnionego z URL-a, nagłówka lub parametru zapytania.
Zaimplementuj katalogi kontrolerów specyficzne dla wersji (np. /v1/controllers, /v2/controllers), gdzie każda wersja ma własne implementacje endpointów z obsługą wstecznej kompatybilności.
Dodaj powiadomienia o deprecacji w nagłówkach odpowiedzi HTTP i dokumentacji, aby konsumenci wiedzieli o planowanym wycofaniu starszych wersji.
Skonfiguruj bramę API lub reverse proxy (opcjonalnie Kong, AWS API Gateway) do routowania żądań na podstawie wersji, jeśli Twoja architektura to wymaga.