versioning-apis

Skill do implementacji strategii wersjonowania API — przez ścieżkę URL (/v1/, /v2/), nagłówki HTTP lub parametry zapytania. Automatycznie zarządzasz warstwami kompatybilności, powiadomieniami o deprecacji i ścieżkami migracji dla konsumentów API. Obsługuje równoczesne wersje, harmonogramy wycofywania i wykrywanie zmian łamiących. Idealny dla zespołów utrzymujących publiczne lub wewnętrzne API z wieloma wersjami.

1. 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.

2. 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.

3. 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.

4. 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.

5. Dodaj powiadomienia o deprecacji w nagłówkach odpowiedzi HTTP i dokumentacji, aby konsumenci wiedzieli o planowanym wycofaniu starszych wersji.

6. Skonfiguruj bramę API lub reverse proxy (opcjonalnie Kong, AWS API Gateway) do routowania żądań na podstawie wersji, jeśli Twoja architektura to wymaga.