Blogs

Blogs

API Explorer, todo lo que necesitas para empezar a usar las APIs de Liferay

Busca, aprende y prueba las APIs Headless de Liferay usando el API Explorer

El API Explorer es una nueva aplicación integrada dentro del portal de Liferay que ofrece todo lo que necesitas para familiarizarte y usar las APIs de Liferay.

Para acceder al API Explorer:

  1. Accede al portal.
  2. Autentícate en el portal.
  3. Navega a la URL /o/api

Allí encontrarás la documentación actualizada de todas las APIs que están disponibles en tu instancia de Liferay para REST y GraphQL.

Usando el API Explorer para explorar las APIs REST

La vista REST es la vista por defecto y la que encontrarás cuando accedas a la aplicación.

Si alguna vez has usado SwaggerHub para buscar documentación sobre APIs, seguramente te resultará familiar, ya que usamos la misma tecnología.

En la parte de arriba a la derecha de la pantalla dispones de un menú desplegable para seleccionar entre todas las APIs disponibles en el portal. Cuando seleccionas una de ellas, la página mostrará todas las rutas disponibles, los métodos para cada ruta y definición de los esquemas o tipos.

Pero no te detengas leyendo la documentación, ¡también puedes hacer pruebas dentro de la aplicación!

  1. Busca la URL que quieres probar entre la lista de rutas de la API.
  2. Haz click en la ruta para expandir la información en detalle.
  3. Pulsa el botón Try it out.
  4. Rellena los parámetros requeridos y el cuerpo de la petición si fuera necesario.
  5. También puedes añadir cabeceras a la petición pulsando en el botón Headers en el borde superior derecho de la pantalla.
  6. Pulsa el botón Execute.
  7. Comprueba el resultado de la petición con la información real que existe en tu instancia del portal de Liferay. (El API Explorer está invocando las rutas reales de tu instalación).
  8. Puedes copiar el comando curl equivalente para usarlo desde la línea de comandos.

Esta es una manera ideal de explorar las APIs disponibles y probar peticiones para después implementarlas en tu código.

Usando el API Explorer para explorar las queries y mutaciones de GraphQL

Si estás más inclinado en usar GraphQL para tu aplicación, puedes explorar todas las queries y mutaciones disponibles en tu instancia del portal pulsando el enlace GraphQL, en la esquina superior derecha de tu pantalla, para así cambiar a la vista de GraphQL.

La vista de GraphQL usa GraphiQL, por lo que será familiar para los que hayáis usado esta herramienta anteriormente. Para aquellos que no, la vista se compone de tres columnas:

  • El Editor de Peticiones, para escribir tus peticiones de GraphQL, que incluye autocompletado y validación.
  • La Ventana de Respuesta, donde comprobar la respuesta recibida a tus peticiones.
  • El Explorador de Documentos, que permite navegar para ver la información de las queries, mutaciones y tipos usados.

Para hacer una petición con GraphQL:

  1. Comienza escribiendo tu petición en el Editor de Peticiones. Deja que el autocompletado y la validación te ayuden a escribir la petición que buscas.
  2. Puedes usar el Explorador de Documentos para comprobar qué queries y mutaciones hay disponibles, cuáles son sus parámetros requeridos y la definición de los tipos que usan.
  3. Pulsa el botón ▶ para ejecutar la petición.
  4. Comprueba la respuesta recibida con la información real alojada en tu instancia del portal.

Añade el API Explorer a tu lista de herramientas

Uses REST o GraphQL para acceder a las funcionalidades expuestas a través de las Headless APIs de Liferay, añadiendo el API Explorer a tu flujo de trabajo serás capaz de aumentar tu productividad como desarrollador con una manera muy sencilla de buscar y entender las APIs y probar tus peticiones antes de implementarlas en tu código.

Todo ello disponible en tu instalación de Liferay, sin la necesidad de configurar nada ni usar herramientas externas.

Si tienes un bundle de Liferay instalado, sólo dirígete a /o/api y empieza a jugar con las APIs.

¡Importante!

No olvides visitar nuestra documentación oficial para encontrar información completa y detallada sobre cómo consumir nuestras APIs REST y GraphQL:

https://learn.liferay.com/dxp/7.x/en/headless-delivery/consuming-apis/consuming-rest-services.html

https://learn.liferay.com/dxp/7.x/en/headless-delivery/consuming-apis/consuming-graphql-apis.html