Usar el Explorador de API

Looker API Explorer es una extensión, una aplicación web compilada con componentes de Looker, que se desarrolla con el marco de trabajo de extensiones de Looker y se implementa a través de Looker Marketplace.

El Explorador de API proporciona los siguientes elementos:

El usuario no necesita acceder a la versión de extensión del Explorador de API, ya que este último usa la cuenta del usuario activo para las solicitudes a la API. Esto garantiza que el usuario solo pueda realizar las llamadas a la API a las que tiene derecho y, al mismo tiempo, elimina la necesidad de proporcionar credenciales de API.

La función sudo como otro usuario de Looker también se puede usar para realizar solicitudes a la API como un usuario diferente a fin de ayudar a diagnosticar problemas de acceso.

Instala el Explorador de API

El Explorador de API está disponible en Marketplace de Looker.

Antes de instalar el Explorador de API desde Marketplace, un administrador de Looker debe habilitar la función Framework de extensión.

Para instalar aplicaciones, como la extensión del Explorador de API, desde Marketplace, debe tener los permisos develop, manage_models y deploy. Una vez que se haya instalado el Explorador de API, cualquier usuario que tenga, como mínimo, el permiso access_data en el modelo extension_api_explorer podrá usarlo. Cada usuario puede ver todos los extremos de la API en el Explorador de API, pero solo puede ejecutar aquellos permitidos por sus permisos.

Si el administrador de Looker habilitó la opción Instalación automática en la página Marketplace de la sección Plataforma del menú Administrador de Looker, el Explorador de API se instalará automáticamente en su instancia. Además, cada vez que haya actualizaciones disponibles, estas se aplicarán automáticamente, lo que garantiza que la versión del Explorador de API en tu instancia sea la más reciente.

Si el administrador de Looker no habilitó la opción Instalación automática, deberás instalar el Explorador de API desde Looker Marketplace.

Consulta la página de documentación Cómo usar Looker Marketplace para obtener instrucciones sobre cómo instalar una extensión desde Looker Marketplace. Para asegurarse de tener siempre la versión más reciente del Explorador de API, vaya a Looker Marketplace, haga clic en Administrar y, luego, en el botón Actualizar que aparece junto a la extensión.

Inicia el Explorador de API

Una vez instalado el Explorador de API, puedes navegar por él de las siguientes maneras:

  1. De la lista de aplicaciones y extensiones instaladas del menú Explorar

  2. Desde la página Aplicaciones y herramientas, disponible desde el menú Examinar y la barra lateral izquierda

  3. Si eres administrador de Looker, también puedes acceder al Explorador de API si haces clic en el vínculo Usar el Explorador de API en la página de Administrador de la API de Looker.

En la página principal del Explorador de API, puedes realizar las siguientes tareas:

  1. Usa el menú desplegable del selector de idioma del SDK para elegir el lenguaje de programación en el que el Explorador de API mostrará el método y las declaraciones de tipo y los resultados de código de la API. El selector usa Python de forma predeterminada en la carga inicial. Si eliges Todas en el selector de idioma, el Explorador de API muestra una vista con pestañas para cada idioma compatible.

  2. Usa el menú desplegable de la versión para elegir una versión de la API:

    - 4.0 - actual

A partir de Looker 22.4, la API de Looker 4.0 está disponible para el público en general. Con esta versión, la API 3.1 ha quedado en desuso y se quitó del Explorador de API, lo que hace que la API 4.0 sea la única versión disponible para visualizar en el Explorador de API. Aunque la página de comparación del Explorador de API aún existe para versiones futuras, actualmente no funciona, ya que la API 4.0 es la única versión disponible.

  1. Ingrese un término de búsqueda en el campo Buscar para limitar los Métodos y Tipos enumerados solo a los que incluyen texto que coincida con su término de búsqueda:

    Cuando seleccionas un método o un tipo mostrado por la búsqueda, el término de búsqueda se destaca en el resumen del método o tipo.

  2. Selecciona la pestaña Métodos para ver las categorías de métodos de API. Puede expandir o contraer una categoría de método para ver los métodos individuales de la categoría.

  3. Selecciona la pestaña Tipos para mostrar los tipos de API. Los tipos no están categorizados y se muestran en orden alfabético.

  4. Haga clic en el ícono de tres barras para ocultar o mostrar el panel de navegación del Explorador de API.

Visualiza la documentación y el método de la API

Cuando seleccionas una categoría de método en la pestaña Method, la categoría del método se expande y te muestra todos los métodos de esa categoría:

  1. En el panel principal, se muestran todos los métodos de esa categoría. Puede elegir que se muestren todos los métodos de la categoría o hacer clic en la pestaña de un tipo de método determinado para filtrar la lista por ese tipo de método específico.

  2. Para ver la documentación de un método específico, elige el nombre del método en el panel de navegación o haz clic en el método en el panel principal.

Una vez que seleccionaste un método específico, el Explorador de API muestra la documentación de ese método:

Cuando seleccionas un tipo en la pestaña Type, se muestra la documentación de ese tipo en el panel principal:

Declaraciones de métodos y tipos

El Explorador de API renderiza el método y las declaraciones de tipo del SDK en el idioma del SDK que se elige en el menú desplegable del selector de idioma del SDK. Si el selector de idioma del SDK está configurado en Todos, las declaraciones de métodos y tipos se muestran en todos los idiomas compatibles del SDK, separadas por tabulaciones:

Ejemplos de SDK

El repositorio sdk-codegen de Looker tiene una carpeta que contiene ejemplos del SDK de Looker. Si el repositorio sdk-codegen tiene ejemplos de un método, la página del Explorador de API del método mostrará una sección Ejemplos de SDK con vínculos a los ejemplos.

Si seleccionas un idioma específico del SDK, se mostrarán primero los ejemplos correspondientes. Por ejemplo, la siguiente tabla de ejemplos de SDK muestra Swift como el idioma seleccionado:

También se pueden mostrar ejemplos de Ruby y Java, aunque no son lenguajes de SDK.

Referencias

La sección References para cada método y tipo incluye vínculos a las páginas del Explorador de API para cada método o tipo al que hace referencia el método o tipo original:

Usa Run It para solicitar y mostrar llamadas a la API

El Explorador de API incluye un botón Ejecutar que abre un panel desde el cual puedes solicitar llamadas a la API y mostrar las respuestas en una variedad de formatos compatibles:

Cuando haces clic en el botón Run It, el Explorador de API muestra una pestaña Request en la que puedes proporcionar las entradas para el método de la API:

Ingrese la entrada deseada y haga clic en Ejecutar para ejecutar la llamada a la API.

Cuando el método de la API puede cambiar datos (para cualquier llamada de REST que sea una POST, una PATCH, una UPDATE o una DELETE), aparece la casilla de verificación de confirmación de cambio de datos y se debe marcar antes de que se pueda ejecutar la solicitud.

Cuando se ejecuta la solicitud, la pestaña Respuesta muestra los resultados:

Además, la pestaña Code muestra la sintaxis de llamada al SDK para el SDK que se elige en el menú desplegable del selector de idioma. Si el selector de idioma del SDK está configurado en All, la sintaxis de la llamada al SDK se muestra en todos los idiomas del SDK compatibles, separados por tabulaciones:

Tipos de visualización de respuestas

Las respuestas del Explorador de API incluyen un tipo de MIME que se usa para determinar cómo mostrar los resultados.

CSV y otros datos tabulares

Para CSV y JSON, se realiza una prueba de forma simple para determinar si los datos se parecen a una tabla. Si los datos de la carga útil se parecen a una tabla, la visualización predeterminada para la respuesta es una cuadrícula de datos:

La pestaña Sin procesar se puede usar para mostrar los datos no transformados:

JSON

Las cargas útiles JSON pueden ser tabulares, en cuyo caso se mostrarán en una cuadrícula. Los encabezados de columna de la consulta de LookML son diferentes para el formato JSON y para CSV:

Las cargas útiles JSON complejas omiten la visualización de cuadrícula y muestran solo el JSON sin procesar:

PNG y JPEG

A continuación, se muestra un ejemplo de la misma consulta anterior, presentada en formato PNG. JPEG se maneja de manera similar:

SVG

Algunos extremos de Looker muestran SVG, que también es compatible directamente. A continuación, se muestra un ejemplo del extremo content_thumbnail en formato SVG:

HTML

El código fuente HTML está destacado en la pestaña Respuesta (Response):

Texto

SQL y otras respuestas que son MIME escritas como texto sin formato se muestran de la siguiente manera:

Comparación de las versiones de API

A partir de Looker 22.4, la API de Looker 4.0 está disponible para el público en general. Con esta versión, la API 3.1 ha quedado en desuso y se quitó del Explorador de API, lo que hace que la API 4.0 sea la única versión disponible para visualizar en el Explorador de API. Aunque la página de comparación del Explorador de API aún existe para versiones futuras, actualmente no funciona, ya que la API 4.0 es la única versión disponible.

El Explorador de API incluye una página que te permite comparar diferentes versiones de la API de Looker y ver qué cambió entre ellas. Haga clic en el triángulo en la parte superior derecha de la página para abrir la página de comparación del Explorador de API.

  1. Selecciona la versión base de la API y la versión de la API que deseas comparar con la versión base.

  2. Seleccione las opciones de API que desea incluir en la comparación para filtrar los métodos solo a aquellos que tengan diferencias en las opciones que seleccione. Las opciones son las siguientes:

    • Missing: Muestra todos los métodos que existen en una versión de la API y que faltan en la otra.
    • Estado: muestra todos los métodos en los que ha cambiado el estado del método. Por ejemplo, un método en el que el estado cambió de beta a stable.
    • Parámetros: Muestra todos los métodos en los que uno o más parámetros cambiaron.
    • Tipo: Muestra los tipos que tienen propiedades nuevas, quitadas o modificadas.
    • Cuerpo: Muestra los cambios en los parámetros del cuerpo.
    • Respuesta: Muestra todos los métodos en los que hubo un cambio en la respuesta del método.

  3. La página de comparación le muestra la cantidad de métodos en los que existe una diferencia y los enumera en los cuales existe una diferencia.

  4. Haz clic en un método para expandirlo y la página de comparación mostrará una diferencia que muestra cómo ha cambiado el método entre versiones.