api-versioning-strategy
/api-versioning-strategy
Wdraża wersjonowanie API przez ścieżki URL, nagłówki lub parametry zapytania ze zgodnością wsteczną i strategiami wycofywania.
- Autor
- secondsky ↗
- Repozytorium
- claude-skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 26.09.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 26.09.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
Wdraża wersjonowanie API przez ścieżki URL, nagłówki lub parametry zapytania ze zgodnością wsteczną i strategiami wycofywania.
Oryginalny opis (EN)
Implements API versioning using URL paths, headers, or query parameters with backward compatibility and deprecation strategies. Use when managing multiple API versions, planning breaking changes, or designing migration paths.
Jak działa
- Versioning Methods
- URL Path Versioning (Recommended)
- Version Adapter Pattern
- Deprecation Headers
- Safe vs Breaking Changes
- Deprecation Timeline
- Best Practices
Podgląd SKILL.md
---
name: api-versioning-strategy
description: Implements API versioning using URL paths, headers, or query parameters with backward compatibility and deprecation strategies. Use when managing multiple API versions, planning breaking changes, or designing migration paths.
license: MIT
---
# API Versioning Strategy
Choose and implement API versioning approaches with proper deprecation timelines.
## Versioning Methods
| Method | Example | Pros | Cons |
|--------|---------|------|------|
| URL Path | `/api/v1/users` | Clear, cache-friendly | URL clutter |
| Header | `API-Version: 1` | Clean URLs | Hidden, harder to test |
| Query | `?version=1` | Easy to use | Not RESTful |
## URL Path Versioning (Recommended)
```javascript
const v1Router = require('./routes/v1');
const v2Router = require('./routes/v2');
app.use('/api/v1', v1Router);
app.use('/api/v2', v2Router);
```
## Version Adapter Pattern
```javascript
// Transform between versions
const v1ToV2 = (v1Response) => ({
data: {
type: 'user',
id: v1Response.user_id,
attributes: {
name: v1Response.user_name,
email: v1Response.email
}
}
});
```
## Deprecation Headers
```javascript
app.use('/api/v1', (req, res, next) => {
res.setHeader('Deprecation', 'true');
res.setHeader('Sunset', 'Sat, 01 Jun 2025 00:00:00 GMT');
res.setHeader('Link', '</api/v2>; rel="successor-version"');
next();
});
```
## Safe vs Breaking Changes
**Safe Changes** (no version bump):
- Adding optional fields
- Adding new endpoints
- Adding optional parameters
**Breaking Changes** (requires new version):
- Removing fields
- Changing field types
- Restructuring responses
- Removing endpoints
## Deprecation Timeline
| Phase | Duration | Actions |
|-------|----------|---------|
| Deprecated | 3 months | Add headers, docs |
| Sunset Announced | 3 months | Email users |
| Read-Only | 1 month | Disable writes |
| Shutdown | - | Return 410 Gone |
## Best Practices
- Support N-1 versions minimum
- Provide 6+ months migration window
- Include migration guides with code examples
- Monitor version usage to inform deprecation
Wersje
W bazie nie ma innych skilli o nazwie api-versioning-strategy.
Migawka bazy z 13.11.2026 · wersja paczki 4c59876b79cf (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
- 100versioning-apis
Wdraża wersjonowanie API ze zgodnością wsteczną, komunikatami o wycofaniu i ścieżkami migracji. - 100versioning-apis
Wdraża wersjonowanie API ze zgodnością wsteczną, komunikatami o wycofaniu i ścieżkami migracji. - 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-helper
Doradza w strategiach wersjonowania API, projektuje procesy wycofywania, generuje przewodniki migracji i klasyfikuje zmiany łamiące i niełamiące. - 100api-versioning
Opisuje strategie wersjonowania API w ASP.NET Core z biblioteką Asp.Versioning: segment URL, nagłówek, query string, deprecjacja wersji i integracja z OpenAPI.