El Explorador de APIs 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 que se implementa a través de Looker Marketplace.
El Explorador de APIs proporciona los siguientes recursos para usar con la API de Looker:
- Documentación para todos los métodos y tipos de la API de Looker
- Declaraciones de métodos y tipos en todos los idiomas de 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 APIs 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 a la API y las funciones del SDK
- Una herramienta de comparación que muestra las diferencias en las versiones de la API de Looker
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 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 y ayudar a diagnosticar problemas de acceso.
Cómo instalar el Explorador de API
El Explorador de APIs está disponible en Looker Marketplace.
Antes de instalar el Explorador de APIs desde Marketplace, un administrador de Looker debe habilitar la función del framework de extensiones.
Para instalar aplicaciones (como la extensión del Explorador de APIs) desde Marketplace, debes tener los permisos develop, manage_models y deploy. Una vez que se instala el Explorador de APIs, cualquier usuario con, al menos, el permiso access_data en el modelo extension_api_explorer puede usar el Explorador de APIs. Cada usuario puede ver todos los extremos de la API en el Explorador de APIs, pero solo puede ejecutar los que permitan sus permisos.
Si el administrador de Looker habilitó la opción Auto Install en la página Marketplace de la sección Platform del menú Administrador de Looker, el Explorador de APIs se instalará automáticamente en tu instancia. Además, cada vez que haya actualizaciones disponibles, estas se aplicarán automáticamente, lo que garantizará que la versión del Explorador de APIs de 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 APIs desde Looker Marketplace.
Consulta la página de documentación Usa Looker Marketplace y obtén instrucciones para instalar una extensión de Looker Marketplace. Para asegurarte de tener siempre la versión más actualizada del Explorador de APIs, ve a Looker Marketplace, selecciona Administrar y selecciona el botón Actualizar junto a la extensión.
Inicia el Explorador de APIs
Una vez que el Explorador de APIs esté instalado, puedes navegar hasta él desde la sección Aplicaciones de la barra lateral izquierda.
Navegar en el Explorador de APIs
Desde la página principal del Explorador de APIs, puedes realizar las siguientes tareas:
Usa el menú desplegable del selector de lenguaje del SDK para elegir el lenguaje de programación en el que el Explorador de APIs mostrará el método, el tipo de API y los resultados del 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 APIs 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 Compare Specifications para abrir la página de comparación de versiones de la API.
Ingresa un término de búsqueda en el campo Buscar para limitar la lista de Métodos y Tipos a solo aquellos que incluyan texto que coincida con tu término de búsqueda.
Cuando seleccionas un método o tipo que muestra la búsqueda, el término de búsqueda se destacará en el resumen del método o el 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étodos para ver los métodos individuales en la categoría.
Selecciona la pestaña Types para mostrar los tipos de API. Los tipos no se clasifican y se enumeran en orden alfabético.
Selecciona el botón de Menú principal para ocultar o mostrar el panel de navegación del Explorador de APIs.
Ver la documentación sobre el tipo y el método de la API
Cuando seleccionas una categoría de métodos en la pestaña Method, se expande la categoría de método y se muestran todos los métodos que están en esa categoría.
Todos los métodos que se encuentran 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 seleccionar la pestaña de un tipo de método en particular para filtrar la lista solo con 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 selecciones un método específico, el Explorador de APIs mostrará la documentación de ese método.
Cuando seleccionas un tipo de la pestaña Type, la documentación correspondiente se muestra en el panel principal.
Declaraciones de métodos y tipos
El Explorador de APIs renderiza las declaraciones de tipo y método de SDK en el idioma del SDK elegido 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étodo y tipo se muestran en todos los idiomas de SDK compatibles, 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 para un método, la página del Explorador de APIs del método mostrará una sección Ejemplos de SDK con vínculos a los ejemplos.
Si se selecciona un idioma de SDK específico, primero se mostrarán los ejemplos para ese idioma.
También es posible que se muestren ejemplos de Ruby y Java, aunque no son lenguajes SDK.
Referencias
En la sección Referencias de cada método y tipo, se incluyen 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 Run It para solicitar y mostrar llamadas a la API
El Explorador de APIs incluye un botón Ejecutarlo 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 APIs 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.
Siempre que el método de la API pueda cambiar datos (para cualquier llamada de REST que sea
POST,PATCH,UPDATEoDELETE), aparecerá la casilla de verificación de confirmación de cambio de datos y deberá marcarse antes de que se pueda ejecutar la solicitud.
Cuando se ejecuta la solicitud, los resultados se muestran en la pestaña Respuesta.
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 se establece en Todos, la sintaxis de la llamada al SDK se muestra en todos los idiomas compatibles del SDK, separados por pestañas.
Tipos de visualización de respuesta
Las respuestas del Explorador de APIs 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 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 este caso, se mostrarán en una cuadrícula. Los encabezados de las columnas para la consulta de LookML se muestran en el formato <view_name>.<field_name>, en lugar de mostrar la etiqueta del campo.
Las cargas útiles de JSON complejas 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 seleccionada 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ó anteriormente, pero con una visualización de tabla. JPEG se maneja de manera similar.
SVG
Algunos extremos de Looker muestran SVG, que también es compatible 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 devuelven código fuente HTML muestran el código fuente en la pestaña Respuesta.
Texto
Las solicitudes que muestran SQL o algún otro formato MIME escrito como texto sin formato se muestran como texto sin formato en la pestaña Respuesta.
Compara versiones de API
El Explorador de APIs incluye una página que te permite comparar diferentes versiones de la API de Looker para ver los cambios entre versiones. Selecciona el botón triangular Compare Specifications, ubicado en la esquina superior derecha de la página, para abrir la página de comparación del Explorador de APIs.
Selecciona la versión base de la API y la versión de la API que deseas comparar con la versión base.
Selecciona las opciones de API que quieras incluir en la comparación para filtrar los métodos solo a aquellos que tengan diferencias en las opciones que selecciones. 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 de los parámetros de los métodos cambiaron.
- Tipo: Muestra los tipos que tienen propiedades nuevas, que se quitaron o cambiaron.
- 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.
En la página de comparación, se muestra la cantidad de métodos en los que hay una diferencia y se enumeran los métodos en los que hay una diferencia.
Selecciona un método para expandirlo y, en la página de comparación, se mostrará una diferencia que indica cómo cambió el método entre versiones.