Versionamiento de APIs | Arquitecto de APIs

En esta entrada del blog CONSULTORJAVA.com quiero contarte sobre algunas experiencias relacionadas al versionamiento de las APIs (el software lo versionamos para hacerle evoluciones, lo mismo sucede para las APIs).

Un API define un contrato de intercambio de información entre un cliente y un servidor dentro y fuera de la organización.

El cliente puede realizar una serie de operaciones como LEER , CREAR, ACTUALIZAR o ELIMINAR algún tipo de recurso en el servidor. Esas operaciones están escritas en el contrato de intercambio de información.

Un cambio en el recurso puede o no requerir un cambio en el contrato.

Algunos cambios, como correcciones de errores menores, pueden no requerir ninguna alteración del contrato. Otros, como un cambio en la estructura del recurso o la forma de comunicación, pueden requerir un cambio en el contrato. Los cambios pueden o no ser compatibles con versiones anteriores. Si el cambio es compatible con versiones anteriores, es posible controlarlo dentro de la misma versión de API. Los cambios que no son compatibles con versiones anteriores requieren que se introduzca una nueva versión de la API. Esto permite al consumidor saber que puede necesitar realizar cambios en el código de su aplicación.