El Explorador de la API de Looker es una extensión, una aplicación web que se compila con componentes de Looker, que se desarrolla con el framework de extensiones de Looker y se implementa a través de Looker Marketplace.
El Explorador de API proporciona los siguientes elementos:
- Documentación para todos los métodos y tipos de la API de Looker
- Declaraciones de métodos y tipo en todos los lenguajes del SDK compatibles
- Vínculos a funciones del SDK de ejemplo que usan métodos de API
- Vínculos a las páginas del Explorador de API para los métodos y tipos de referencia
- Una función Run It que te permite ejecutar llamadas a la API directamente 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 entre las versiones de la API de Looker
El usuario no necesita acceder a la versión de la extensión del Explorador de API, ya que este 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 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 y así ayudar a diagnosticar problemas de acceso.
Instala el Explorador de API
El Explorador de APIs 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 la 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 se instala el Explorador de API, cualquier usuario que tenga 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 los que permitan 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, se instalará automáticamente el Explorador de APIs en tu 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 Usa la plataforma de Looker Marketplace si necesitas instrucciones para instalar una extensión de Looker Marketplace. Para asegurarte de tener siempre la versión más actualizada del Explorador de API, ve a Looker Marketplace, selecciona Administrar y elige el botón Actualizar junto a la extensión.
Inicia el Explorador de API
Una vez instalado, puedes navegar hasta é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 idioma del SDK para elegir el lenguaje de programación en el que el Explorador de API mostrará el método de la API, las declaraciones de tipo y los resultados de código. El selector se establece de forma predeterminada en Python en la carga inicial. Si eliges Todos en el selector de idioma, el Explorador de API muestra una vista con pestañas para cada idioma compatible.
Usa el menú desplegable de versiones para elegir una versión de la API:
- 4.0 - Actual
Selecciona el botón Comparar especificaciones para abrir la página de comparación de versiones de la API.
Ingresa un término de búsqueda en el campo Search para limitar los Métodos y Tipos enumerados a solo aquellos que incluyen texto que coincida con el término de búsqueda.
Cuando seleccionas un método o un tipo que devuelve la búsqueda, el término de búsqueda se destaca en el método o el resumen del tipo.
Selecciona la pestaña Métodos para mostrar las categorías de métodos de la API. Puedes expandir o contraer una categoría de métodos para ver los métodos individuales de la categoría.
Selecciona la pestaña Tipos para mostrar los tipos de API. Los tipos no se clasifican y se enumeran en orden alfabético.
Selecciona el botón Menú principal para ocultar o mostrar el panel de navegación del Explorador de API.
Ver la documentación del método y los 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 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 optar por 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 para que incluya solo ese tipo de método.
Para ver la documentación de un método específico, elige el nombre del método en el panel de navegación o selecciónalo en el panel principal.
Una vez que hayas seleccionado un método específico, el Explorador de API mostrará la documentación para ese método.
Cuando seleccionas un tipo en la pestaña Tipo, la documentación de ese tipo se muestra en el panel principal.
Declaraciones de método y tipo
El Explorador de API renderiza el método del SDK y las declaraciones de tipo en el lenguaje de SDK que se elige en el menú desplegable del selector de idioma del SDK. Si el selector de idioma del SDK está configurado en All, las declaraciones del método y el tipo se muestran en todos los idiomas del SDK compatibles, separadas por pestañas.
Ejemplos de SDK
El repositorio de 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á la sección Ejemplos de SDK con vínculos a los ejemplos.
Si se selecciona un lenguaje de SDK específico, se mostrarán primero los ejemplos para ese lenguaje.
Es posible que también se muestren ejemplos de Ruby y Java, aunque estos no son 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 para cada método o tipo al que hace referencia el método o tipo original.
Cómo usar la función Ejecutarlo para solicitar y mostrar llamadas a la API
El Explorador de API incluye un botón Ejecutarlo que abre un panel desde el que 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 Run para ejecutar la llamada a la API.
Cuando el método de la API puede cambiar datos (para cualquier llamada REST que sea
POST,PATCH,UPDATEoDELETE), aparecerá la casilla de verificación de confirmación de cambio de datos, que se debe verificar antes de 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 que se elige en el menú desplegable del selector de idioma. Si el selector de idioma del SDK está configurado en Todos, la sintaxis de la llamada al SDK se muestra en todos los idiomas del SDK compatibles, separados por pestañas.
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
En el caso de los datos CSV y JSON, Looker realiza una prueba de forma para 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 para la respuesta es una cuadrícula de datos.
Selecciona la pestaña Sin procesar para mostrar los datos sin transformar.
JSON
Las cargas útiles de JSON pueden ser tabulares, en cuyo caso se mostrarán en una cuadrícula. Los encabezados de columna para la consulta de LookML se muestran con el formato <view_name>.<field_name>, en lugar de mostrar la etiqueta del campo.
Las cargas útiles complejas de JSON omiten la visualización de la cuadrícula y muestran solo el JSON sin procesar.
PNG y JPEG
Los formatos PNG y JPEG muestran la visualización que se selecciona para la consulta e incluyen cualquier configuración de visualización aplicada. El siguiente ejemplo es el resultado en formato PNG de la misma consulta que se mostró antes, pero con una visualización de tabla. JPEG se maneja de manera similar.
SVG
Algunos extremos de Looker muestran SVG, que también son compatibles de forma directa. 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 el código fuente HTML muestran el código fuente HTML en la pestaña Respuesta.
Texto
Las solicitudes que muestran SQL o algún otro formato con MIME escrito como texto sin formato se muestran como texto sin formato en la pestaña Respuesta.
Comparación de versiones de API
El Explorador de APIs incluye una página que te permite comparar diferentes versiones de la API de Looker para ver qué cambió entre 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 quieres comparar con la versión base.
Selecciona las opciones de API que deseas incluir en la comparación para filtrar los métodos y ver solo aquellos que tengan diferencias en las opciones que seleccionas. Las opciones son las siguientes:
- Sin entregar: 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ó su estado. Por ejemplo, un método en el que el estado cambió de
betaastable. - Parámetros: Muestra todos los métodos en los que cambiaron uno o más de los parámetros del método.
- 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 se produjo un cambio en la respuesta del método.
La página de comparación te muestra la cantidad de métodos en los que hay una diferencia y los que sí hay.
Selecciona un método para expandirlo, y la página de comparación mostrará una diferencia que muestra cómo cambió el método entre las versiones.