This website uses cookies to ensure you get the best experience. Learn More.
API Explorer, todo lo que necesitas para empezar a usar las APIs de Liferay
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:
Allí encontrarás la documentación actualizada de todas las APIs que están disponibles en tu instancia de Liferay para REST y GraphQL.
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!
Esta es una manera ideal de explorar las APIs disponibles y probar peticiones para después implementarlas en tu código.
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:
Para hacer una petición con GraphQL:
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.