Qué es Versionado de API
Gestión de versiones de API
Versionado de API
Versionado de API es la práctica de gestionar cambios en la API manteniendo la compatibilidad hacia atrás para clientes existentes.
Estrategias de versionado
| Estrategia | Ejemplo | Descripción | |------------|---------|-------------| | Ruta URL | /api/v1/users | Versión en ruta URL | | Parámetro Query | /api/users?version=1 | Versión en parámetro | | Header | X-API-Version: 1 | Versión en cabecera | | Content Type | Accept: application/vnd.api.v1+json | Versión en media type |
Versionado semántico
- Major (v1→v2) — cambios incompatibles
- Minor (v1.1→v1.2) — nuevas funciones, compatible hacia atrás
- Patch (v1.1.0→v1.1.1) — corrección de errores
Mejores prácticas
- Documentar todos los cambios (changelog)
- Soportar al menos 2 versiones
- Anunciar deprecación con anticipación
- Usar headers sunset
- Proporcionar herramientas de migración
Cuándo se necesita una nueva versión
- Eliminar campos o endpoints
- Cambiar formato de respuesta
- Cambiar semántica de parámetros
- Cambiar autenticación