Fija el contrato
Conserva la versión de OpenAPI utilizada para generar o validar tu integración.
Referencia · Evolución
Versiona la integración contra un contrato identificable.
Las operaciones de negocio utilizan el prefijo /v1 y el artefacto OpenAPI identifica la revisión exacta del contrato que consume tu aplicación.
Prefijo HTTP/v1
OpenAPI0.1.0
EstadoPrelanzamiento
Qué está vigente hoy
- El contrato descargable declara la versión
0.1.0. - Las rutas públicas de negocio se agrupan bajo
/v1. - Un cambio no está terminado hasta actualizar OpenAPI, guías y changelog en el mismo cambio versionado.
- La promoción a producción requiere release identificada y aprobación humana V4.
Prepara una integración resistente
Tolera extensiones
No rechaces automáticamente campos adicionales en respuestas o eventos si no alteran tu flujo.
Decide por códigos
Usa estados, códigos de error y tipos de evento documentados; no analices textos descriptivos.
Prueba antes de promover
Valida los cambios en el ambiente no productivo asignado antes de actualizar producción.
Qué deberá definir la política definitiva
| Decisión | Debe concretar |
|---|---|
| Compatibilidad | Qué cambios son aditivos y cuáles requieren nueva versión. |
| Deprecación | Plazo mínimo, cabeceras y canales de comunicación. |
| Retirada | Criterios de Sunset, migración y soporte de versiones. |
| Responsabilidad | Propietario que aprueba y comunica cada cambio público. |