Looker Explorer API es una extensión, una aplicación web compilada con componentes de Looker, que se desarrolla con el framework de extensión de Looker y que se implementa a través de Looker Marketplace.
El Explorador de API proporciona los siguientes elementos:
- Documentación de todos los métodos y tipos de la API de Looker
- Declaraciones de métodos y tipos en todos los lenguajes de SDK compatibles
- Vínculos a funciones de SDK de ejemplo que usan métodos de API
- Vínculos a páginas del Explorador de API para los tipos y métodos de referencia
- Una función Ejecutar que te permite ejecutar llamadas a la API de forma directa y proporciona el código para las llamadas a la API, las respuestas de la API y las funciones del SDK
- Una herramienta de comparación que muestra las diferencias en las versiones de la API de Looker
No es necesario que el usuario acceda a la versión de la 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 que proporcione 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.
Cómo instalar 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, debes tener los permisos develop, manage_models y deploy. Una vez que el Explorador de API se haya instalado, cualquier usuario con, al menos, el permiso access_data en el modelo extension_api_explorer puede 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ú de Administrador de Looker, el Explorador de API se instalará automáticamente en tu instancia. Además, cada vez que haya actualizaciones disponibles se aplicarán automáticamente, lo que garantizará que la versión del Explorador de API en tu instancia sea la más actual.
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 Usa Looker Marketplace para obtener instrucciones sobre cómo instalar una extensión desde Looker Marketplace. Para asegurarte de tener siempre la versión más reciente del Explorador de API, ve a Looker Marketplace, selecciona Manage y haz clic en el botón Update junto a la extensión.
Cómo iniciar el Explorador de API
Una vez que esté instalado el Explorador de API, puede navegar a él desde la sección Aplicaciones de la barra lateral izquierda.
Cómo navegar en el Explorador de API
En la página principal del Explorador de API, puedes realizar las siguientes tareas:
Usa el menú desplegable del selector de lenguaje de SDK para elegir el lenguaje de programación en el que el Explorador de API mostrará las declaraciones de tipo y los métodos de la API y los resultados del código. El selector se establece de forma predeterminada en Python en la carga inicial. Si eliges All en el selector de idioma, el Explorador de API muestra una vista con pestañas para cada idioma compatible.
Usa el menú desplegable de la versión para elegir una versión de la API:
- 4.0 - actual
- 3.1 - heredado
Selecciona el botón Comparar especificaciones para abrir la página de comparación de versiones de la API.
Ingrese un término de búsqueda en el campo Buscar para limitar los Métodos y Tipos indicados solo a aquellos que incluyan texto que coincida con su término de búsqueda.
Cuando seleccionas un método o tipo que muestra la búsqueda, el término de búsqueda se destaca en el método o resumen del tipo.
Selecciona la pestaña Methods para mostrar las categorías de métodos de la API. Puedes expandir o contraer una categoría de método para ver los métodos individuales en la categoría.
Selecciona la pestaña Tipos para mostrar los tipos de API. Los tipos no están categorizados y se muestran en orden alfabético.
Seleccione el botón Menú principal para ocultar o mostrar el panel de navegación del Explorador de API.
Visualiza la documentación sobre los métodos y tipos de 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 que están en esa categoría.
Todos los métodos que están en esa categoría se muestran en el panel principal. Puedes elegir mostrar todos los métodos que están en la categoría o puedes seleccionar la pestaña de un tipo de método en particular para filtrar la lista solo por ese tipo de método.
Para ver la documentación de un método específico, selecciona el nombre del método en el panel de navegación o selecciona el método en el panel principal.
Una vez que seleccionas 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, la documentación para ese tipo se muestra en el panel principal.
Declaraciones de método y tipo
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 se establece en All, las declaraciones de métodos y tipos se muestran en todos los idiomas de SDK compatibles, separados 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 para un método, la página del Explorador de API del método mostrará una sección de ejemplos del SDK con vínculos a los ejemplos.
Si seleccionas un idioma específico del SDK, aparecerán los ejemplos correspondientes.
También puede haber ejemplos de Ruby y Java, aunque estos no sean lenguajes de SDK.
Referencias
La sección Referencias de cada método y tipo incluye vínculos a las páginas del Explorador de API de cada método o tipo a los que se hace referencia en 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 Run It que abre un panel desde el cual puedes solicitar llamadas a la API y mostrar las respuestas en una variedad de formatos compatibles.
Cuando seleccionas el botón Run It, el Explorador de API muestra una pestaña Request en la que puedes proporcionar las entradas al método de la API.
Ingresa la entrada deseada y selecciona 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
POST,PATCH,UPDATEoDELETE), aparece la casilla de verificación de confirmación de cambio de datos y se debe verificar 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 la llamada al SDK para el SDK que se elige en el menú desplegable del selector de idioma. Si el selector de idioma del SDK se establece en All, la sintaxis de la llamada al SDK se muestra en todos los idiomas compatibles del SDK, separados por pestañas.
Tipos de anuncios gráficos de respuesta
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 los datos CSV y JSON, Looker realiza una prueba de forma a fin de determinar si los datos cumplen con los criterios de una tabla. Si Looker determina que los datos de la carga útil son tabulares, la visualización predeterminada de la respuesta es una cuadrícula de datos.
Selecciona la pestaña Sin procesar 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 LookML se muestran en el formato <view_name>.<field_name>, en lugar de mostrar la etiqueta del campo.
Las cargas útiles JSON complejas omiten la visualización de la cuadrícula y solo muestran el JSON sin procesar.
PNG y JPEG
Los formatos PNG y JPEG muestran la visualización seleccionada para la consulta e incluyen cualquier configuración de visualización aplicada. El siguiente ejemplo es el archivo PNG de la misma consulta mostrada anteriormente, pero con una visualización de tabla. JPEG se maneja de manera similar.
SVG
Algunos extremos de Looker muestran SVG, que también se admite directamente. A continuación, se muestra un ejemplo del extremo content_thumbnail en formato SVG, que muestra una imagen en miniatura abstracta de un panel.
HTML
Las solicitudes que muestran un código fuente HTML muestran el código fuente HTML en la pestaña Respuesta.
Texto
Las solicitudes que muestran SQL, o bien otros formatos de tipo MIME como texto sin formato, se muestran como texto sin formato en la pestaña Respuesta.
Comparación de versiones de API
El Explorador de API incluye una página que te permite comparar diferentes versiones de la API de Looker para ver los cambios entre las versiones. Selecciona el botón triangular Comparar especificaciones, ubicado en la esquina superior derecha de la página, para abrir la página de comparación del Explorador de API.
Selecciona la versión base de la API y la versión de la API que deseas comparar con la versión base.
Seleccione las opciones de la 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 cambió el estado del método. Por ejemplo, un método en el que el estado cambió de
betaastable. - Parámetros: Muestra todos los métodos en los que uno o más parámetros del método cambiaron.
- Tipo: Muestra los tipos que tienen propiedades nuevas, quitadas o modificadas.
- Cuerpo: Muestra los cambios de los parámetros del cuerpo.
- Respuesta: Muestra todos los métodos en los que hubo un cambio en la respuesta del método.
En la página de comparación, se muestra la cantidad de métodos en los que hay una diferencia y, además, se enumeran los que sí lo son.
Selecciona un método para expandirlo y, en la página de comparación, se mostrará una diferencia que muestra cómo cambió el método entre versiones.