api-versioning-evolution-strategies
/api-versioning-evolution-strategies
Pomaga bezpiecznie wprowadzać zmiany łamiące kompatybilność w API dzięki wersjonowaniu w ścieżce, nagłówku i parametrze zapytania.
- Autor
- nextboxis ↗
- Repozytorium
- library-skill-agents ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 28.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 28.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Pomaga bezpiecznie wprowadzać zmiany łamiące kompatybilność w API dzięki wersjonowaniu w ścieżce, nagłówku i parametrze zapytania.
Oryginalny opis (EN)
Use this skill when managing breaking API changes safely using URL path, custom header, and query parameter versioning.
Jak działa
- When to use
- Prerequisites
- Step-by-step workflow
- Commands / code examples
- Common mistakes & pitfalls
- Verification checklist
- Related skills
Podgląd SKILL.md
---
name: api-versioning-evolution-strategies
description: Use this skill when managing breaking API changes safely using URL path, custom header, and query parameter versioning.
---
# API Versioning & Evolution
## When to use
Use this skill when you need to managing breaking API changes safely using URL path, custom header, and query parameter versioning.
## Prerequisites
- Working knowledge of backend architecture, HTTP protocols, and systems programming.
- Appropriate runtime installed (Node.js, Python, Go, Rust, Java, or .NET depending on stack).
## Step-by-step workflow
1. **Define resource contracts**: Establish unambiguous request and response schemas, validation rules, and error envelopes.
2. **Implement routing & handlers**: Structure modular controllers or handlers keeping transport logic isolated from domain services.
3. **Enforce input validation**: Validate and sanitize all inbound parameters, headers, and payloads before reaching business logic.
4. **Implement robust error handling**: Return standardized error responses with consistent HTTP status codes and correlation IDs.
5. **Optimize resilience & telemetry**: Instrument endpoints with structured logging, health checks, metrics, and timeout boundaries.
## Commands / code examples
```ts
// Example implementation pattern for api-versioning-evolution-strategies
import { Request, Response, NextFunction } from 'express';
export interface StandardApiResponse<T> {
success: boolean;
data?: T;
error?: {
code: string;
message: string;
details?: unknown;
};
meta?: {
timestamp: string;
requestId: string;
};
}
export function apiResponseHandler<T>(data: T, req: Request): StandardApiResponse<T> {
return {
success: true,
data,
meta: {
timestamp: new Date().toISOString(),
requestId: (req.headers['x-request-id'] as string) || 'req_auto_gen',
},
};
}
```
## Common mistakes & pitfalls
- Exposing raw database exceptions or internal stack traces directly in client responses.
- Neglecting request timeouts, allowing hung external dependencies to exhaust server connection pools.
- Omitting correlation IDs (`X-Request-ID`), making distributed debugging impossible across microservices.
## Verification checklist
- [ ] Endpoints adhere strictly to standardized HTTP status codes and contract specifications.
- [ ] Inbound requests are validated against strict type schemas before processing.
- [ ] Errors return structured envelopes without leaking sensitive infrastructure details.
- [ ] All database queries and external service calls have explicit timeout deadlines.
## Related skills
- restful-api-design-best-practices
- api-rate-limiting-throttling
- distributed-tracing-opentelemetry-sdk
- secure-code-review-static-analysis-sast
Wersje
W bazie nie ma innych skilli o nazwie api-versioning-evolution-strategies.
Migawka bazy z 13.11.2026 · wersja paczki e5e2078c26be (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 90backend-api-versioning
Prowadzi przejścia wersji API: wersjonowanie w adresie, w nagłówku lub przez negocjację treści, zmiany łamiące i wycofywanie endpointów. - 100versioning-and-evolution
Projektuje strategię wersjonowania API: ścieżki URL albo nagłówki, wersje oparte na dacie, wycofywanie i nagłówki sunset. - 100api-versioning
Opisuje strategie wersjonowania API dla zgodności frontendu z backendem: wersje w URL, w nagłówkach i wzorce migracji. - 100api-versioning
Wersjonuje API REST i GraphQL, obsługuje zmiany łamiące, wycofywanie i wiele wersji oraz projektuje strategię ewolucji API. - 100api-versioning-strategy
Wdraża wersjonowanie API przez ścieżki URL, nagłówki lub parametry zapytania ze zgodnością wsteczną i strategiami wycofywania. - 100api-versioning-helper
Doradza w strategiach wersjonowania API, projektuje procesy wycofywania, generuje przewodniki migracji i klasyfikuje zmiany łamiące i niełamiące.