Por qué es importante la estrategia de versionado de APIs

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Introducción al versionado de APIs

Introducción al versionado

Analogía del versionado

Se usa cuando los cambios rompientes confundirían a quienes viajan
Mientras se construye la nueva línea, la gente sigue usando la anterior
Las revisiones son como el mantenimiento de la misma línea
- Arreglar vías, añadir señalización, suavizar el viaje
En APIM:
- Las versiones viven dentro de un conjunto de versiones
- Las revisiones te permiten editar, probar y marcar una como actual

Se admiten tres formas de indicar versión:
- Declararla en la ruta de la URL
- Especificarla en el encabezado de la solicitud
- Especificarla en la cadena de consulta de la URL
La estrategia de versionado debe ser coherente

Versionado en ruta de URL

Versionado por encabezado

Versionado por cadena de consulta

Lanzamiento canario

Resultados:
- Si el feedback es bueno -> marca la revisión como actual
- Si es malo -> vuelve a la revisión anterior

Como una prueba de cocina: sirve una receta nueva a pocas mesas primero
En APIM:
- Crea una nueva revisión y pruébala en privado
- Exponla a un público limitado (producto piloto o subconjunto de clientes)
- Apunta a una revisión concreta mediante una URL especial con su número
Metáfora ferroviaria: quienes prueban van por la «vía de mantenimiento» sin afectar la línea principal

API Management

Azure API Management