¿Qué forma de versionar una API es la más común y explícita en APIs REST públicas?
Opciones
- La versión en la ruta de la URL (
/v1/orders) (Opción correcta) - Cambiar los nombres de campos en silencio
- Usar un puerto distinto por versión
- No versionar nunca la API
Respuesta
La versión en la ruta de la URL (/v1/orders)
Por qué
Los clientes se integran con tu API y se rompen si la cambias. Versionar te permite lanzar cambios incompatibles como una versión nueva mientras los clientes antiguos siguen funcionando.
Ponerla en la ruta (/v1/, /v2/) es lo más visible y común. Alternativas: un header o un parámetro de query.
Anuncia pronto lo que vas a retirar y mantén las versiones antiguas activas un tiempo.
Recuerda
Cambio incompatible en la API → versión nueva (/v2).