La mayoría de las aplicaciones se escriben con algún tipo de SDK de cliente o, posiblemente, una URL de la API. El SDK de cliente y las URLs de la API están vinculados a una versión específica de la API de Looker. Tu aplicación seguirá funcionando incluso cuando Looker realice cambios en las versiones nuevas de la API. Tu aplicación no se verá afectada por los cambios en otras versiones de la API hasta que decidas actualizar tu SDK de cliente (o modificar la URL de la API) para usar la nueva versión de la API de Looker.
Cómo Looker realiza cambios en la API
La API de Looker está diseñada para proporcionar estabilidad a los extremos de la API de Looker y, por lo tanto, estabilidad a tus aplicaciones.
A medida que agregamos más funciones y capacidades a Looker, también actualizamos la API de REST de Looker para acceder a esas funciones nuevas o administrarlas. Para cada versión de Looker, agregamos nuevas funciones de la API, parámetros y propiedades de tipo de respuesta a la versión actual de la API de Looker. En la mayoría de los casos, las adiciones a la API no son cambios rotundos, por lo que podemos mantener la versión existente de la API sin afectar ningún código de la aplicación existente que se compile en la API. Es posible que el código de la aplicación existente no conozca las funciones, los parámetros o las funciones nuevas que aparecen en las versiones posteriores de Looker.
Para los cambios en la API que interrumpirían el código de la aplicación existente, agrupamos esos cambios rotundos en una nueva versión de la API. Esto significa que la versión anterior de la API seguirá funcionando como antes, mientras que una nueva versión de la API se ejecuta junto con ella con los cambios y las actualizaciones. Pueden existir varias versiones de la API en paralelo en una sola instancia de Looker para que puedas elegir cuándo actualizar a la nueva versión de la API. El código existente que se compiló para llamar al extremo anterior seguirá llamando al extremo anterior. El código nuevo debe llamar a la versión nueva del extremo en el nivel de versión de la API más reciente.
Una excepción a esto es para problemas de seguridad críticos. Si descubrimos un problema de seguridad crítico relacionado con una parte específica de la API, haremos lo que sea necesario para mitigar ese problema de seguridad lo antes posible, lo que puede incluir inhabilitar la funcionalidad vulnerable hasta que haya una solución adecuada).
Si necesitamos retirar una función, una propiedad o una propiedad para dar paso a una mejor implementación o solución, normalmente dejamos la API actual como está, pero marcamos los extremos de la API asociados como "obsoletos" para indicar que debes alejarte del extremo en el código de tu aplicación.
Cambios rotundos y aditivos en la API
Un cambio rotundo es algo que borra o cambia el nombre de un artefacto existente de un extremo de API. Puede incluir lo siguiente:
- Cambiar o borrar un nombre o tipo de parámetro
- Agregar un parámetro obligatorio nuevo
- Cambiar la URL base
- Cambiar o borrar una propiedad existente en una respuesta
Por otro lado, se puede realizar un cambio aditivo en los extremos estables. Pueden incluir lo siguiente:
- Parámetros opcionales nuevos
- Propiedades nuevas en las respuestas (no consideramos que esto sea un cambio rotundo porque suponemos que tu código ignorará las propiedades desconocidas en las respuestas, lo que es una práctica común en la comunidad de la API de REST)
Si un extremo estable de la API de Looker necesita un cambio significativo para avanzar con una nueva arquitectura o funcionalidad, el cambio suele agregarse a un extremo nuevo y se agrupa en una nueva versión de la API para que el extremo de API existente permanezca sin cambios.
Marcas para extremos de la API
La mayoría de los extremos de la API se consideran estables, lo que significa que no se espera que cambien. Looker no lanzará cambios rotundos en los extremos estables, excepto en casos extremos, como para solucionar un problema de seguridad.
Otros extremos de la API pueden marcarse como beta o obsoletos:
- Los extremos beta están en desarrollo activo y pueden cambiar en el futuro. No están protegidos contra cambios rotundos. Cuando uses extremos beta, considera si un cambio en la API de Looker sería particularmente perjudicial para tu app o ciclo de desarrollo. Lee las notas de la versión de Looker si planeas usar un extremo beta para estar al tanto de los cambios.
- Los extremos obsoletos son extremos que aún son compatibles y se pueden usar en este momento, pero se borrarán en una versión futura. El código anterior que usa un extremo obsoleto debe actualizarse para dejar de usarlo. Cuando una versión futura de Looker quite la compatibilidad con ese extremo, se interrumpirá cualquier código que aún lo use. En la mayoría de los casos, un extremo obsoleto se reemplazará por una funcionalidad mejorada. Si descubres que tu aplicación usa una función o propiedad obsoleta, te recomendamos que refactorices el código para reemplazar el elemento obsoleto lo antes posible.
Los extremos beta y obsoletos se marcan como tales en el Explorador de API y en la referencia de la API 4.0. Los extremos que no están marcados se consideran estables.
Tipos de llamadas a la API
Los tipos de llamadas a la API que se definen como llamadas a la API de consulta son los siguientes:
- Llamadas que son necesarias para las canalizaciones de consultas automatizadas
- Llamadas que obtienen datos de la base de datos del cliente
- Llamadas que ejecutan consultas en SQL o toman resultados para el contenido
Algunos ejemplos son los siguientes:
Los tipos de llamadas a la API que se definen como llamadas a la API de administrador son los siguientes:
- Llamadas que son necesarias para compilar aplicaciones, controlar contenido en instancias y realizar tareas administrativas
- Llamadas que controlan la instancia de Looker (Google Cloud Core)
- Llamadas que realizan la administración de contenido, la administración de permisos y usuarios, la administración de instancias o la extracción de contenido en carpetas
Algunos ejemplos son los siguientes:
Migra a una nueva versión de la API
Cuando decidas actualizar tu SDK de cliente o URL de la API a una nueva versión de la API, deberás revisar el código de tu aplicación para ver si dependes de algo que cambió con la nueva versión de la API. Asegúrate de hacer lo siguiente:
- Busca en el código de tu aplicación los nombres de funciones, valores y propiedades actualizados.
- Verifica que el código de tu aplicación admita los cambios en los tipos (como de número entero a cadena).
- Audita tu código (consulta la sección Audita tu código).
Audita tu código
En algunos lenguajes, los cambios rotundos en la API se pueden descubrir en el momento de la compilación como errores de compilación:
- Si tu aplicación está escrita en un lenguaje compilado y de tipo fuerte, los cambios estructurales en los tipos de parámetros o respuestas en una versión nueva de la API que no coincidan con tu código existente deberían ser evidentes gracias a la verificación de tipos de compilación y los mensajes de error del compilador.
- Si tu aplicación está escrita en un lenguaje dinámico de tipo flexible (como JavaScript, Ruby y Python), puede ser más difícil ubicar las partes de tu aplicación que se verán afectadas por los cambios rotundos en una versión nueva de la API. Es posible que estos tipos de lenguajes requieran pruebas unitarias de tiempo de ejecución para encontrar problemas relacionados con los cambios en los tipos.
En todos los casos, se recomienda tener pruebas unitarias que ejerciten el código de tu aplicación, incluidas las llamadas a la API de Looker (no llamadas simuladas).