Probar la API

OpenAPI   |  gRPC

A partir del 21 de marzo de 2022, el Portal de Cloud Endpoints dejará de estar disponible. El Portal de Cloud Endpoints dejará de estar disponible después del 21 de marzo de 2023. El tráfico de API administrado por Cloud Endpoints no se ve afectado por este cambio. Para obtener más información, consulta Bajas de funciones.

Además de leer la documentación de referencia de la API de SmartDocs, los desarrolladores pueden usar el panel Probar esta API para interactuar con tu API sin salir de la documentación. En tu portal, los desarrolladores pueden enviar solicitudes a la API y ver las respuestas. Probar la API en tu portal ayuda a los usuarios a entender lo que deben hacer para que su propio código funcione en tu API.

Si tu API requiere una clave de API o autenticación, debes configurar el portal para que tus usuarios puedan interactuar con la API. En esta página, se describen la configuración y los requisitos necesarios para que los desarrolladores puedan usar Prueba esta API. Para cada tarea, se proporcionan las funciones mínimas de Identity and Access Management que se requieren a fin de completarla. Si quieres obtener más información sobre los permisos de IAM, consulta los siguientes recursos:

• Comprende las funciones
• Cómo otorgar, cambiar y revocar el acceso a los recursos
• Crea y administra funciones personalizadas

Requisitos previos

• Debes haber implementado el backend de la API.
• Si la API requiere una clave de API, tu documento de OpenAPI debe estar configurado como se describe en Cómo restringir el acceso a la API con claves de API.
• Si tu API requiere autenticación, debes configurar el documento de OpenAPI con el método de autenticación de preferencia. Consulta Elige un método de autenticación.

• La API debe ser accesible a través de DNS.

  • Si implementaste tu API en un entorno flexible de App Engine, se crea una entrada DNS con un nombre en el formato YOUR_PROJECT_ID.appspot.com de forma automática. En el ejemplo anterior, YOUR_PROJECT_ID es el ID del proyecto de Google Cloud en el que implementaste tu API. Esto significa que puedes probar la API en el portal sin ninguna configuración adicional.
  • Para otros backends (como Compute Engine o GKE), si la API no está configurada a fin de usar un nombre de dominio personalizado (por ejemplo, myapi.mycompany.com), debes configurarla de modo que use cloud.goog domain.

Cómo configurar el Explorador de API

Si tu API requiere una clave de API o autenticación de Firebase o Auth0, debes definir esta configuración antes de que los usuarios puedan probarla. En esta sección, se describe cómo establecer una configuración de clave de API y autenticación.

Permisos necesarios para esta tarea

A fin de realizar esta tarea, debes tener la función Editor del proyecto en el proyecto.

Cómo configurar una clave de API

Para configurar una clave de API en tu portal, sigue estos pasos:

1. En Google Cloud Console, ve a API & Servicios > Credenciales.

   Ir a la página Credenciales

2. En la lista desplegable Proyecto en la ventana superior de Google Cloud Console, selecciona el proyecto de Google Cloud en el que creaste la API.

   • Si ya tienes una clave de API que quieres usar, sigue estos pasos:

     1. Haz clic en Editar clave de API  junto a la clave de API que quieres usar.
     2. A la derecha de la clave API, haz clic en Copiar para copiar la clave de API en el portapapeles.
     3. Haz clic en Cancelar.

   • Si necesitas crear una clave de API, sigue estos pasos:

     1. Haz clic en Crear credenciales y selecciona Clave de API.
     2. Copia la clave al portapapeles.
     3. Haz clic en Cerrar.

3. Regresa al portal.

4. Haz clic en Configuración.

5. Haz clic en la pestaña API y selecciona tu API de la lista desplegable.

6. En la sección Configuración del explorador de API, pega la clave de API en el campo Clave de API de Google.

7. Haz clic en Guardar.

Cómo configurar Firebase

Para configurar Firebase, sigue estos pasos:

1. Abre Firebase Console.

   • Si no tienes un proyecto de Firebase existente, sigue estos pasos:

     1. Haz clic en Agregar proyecto y selecciona el nombre del proyecto de Google Cloud en el que se encuentra tu API.
     2. En la tarjeta Autenticación, haz clic en Comenzar.
     3. Haz clic en la pestaña Método de acceso.
     4. En la sección Proveedores de acceso, habilita los proveedores que quieres usar.
     5. En la sección Dominios autorizados, haz clic en Agregar dominio y agrega el nombre de dominio de tu portal (por ejemplo, endpointsportal.example-api.example.com).
     6. Haz clic en Configuración web. Se mostrará el fragmento de código personalizado. Deja abierta la pestaña de Firebase Console, porque necesitarás la información del fragmento de código en los siguientes pasos.

   • Si ya tienes un proyecto de Firebase existente, sigue estos pasos:

     1. Ve a Desarrollo > Autenticación.
     2. Haz clic en la pestaña Método de acceso.
     3. En la sección Dominios autorizados, haz clic en Agregar dominio y agrega el nombre de dominio de tu portal (por ejemplo, endpointsportal.example-api.example.com).
     4. Haz clic en Configuración web. Se mostrará el fragmento de código personalizado. Deja abierta la pestaña de Firebase Console, porque necesitarás la información del fragmento de código en los siguientes pasos.

2. Abre otra pestaña en tu navegador y ve al portal.

3. Haz clic en Configuración.

4. En la página Configuración, haz clic en la pestaña API y selecciona tu API de la lista desplegable.

5. En la sección Configuración del Explorador de API, haz lo siguiente:

   1. Copia el valor del campo apiKey del fragmento de código de Firebase y pégalo en el campo Clave de API de Google.
   2. Copia el valor del campo authDomain del fragmento de código de Firebase y pégalo en el campo Dominio de autenticación de Firebase.

6. Haz clic en Guardar.

Consulta la documentación de Firebase para obtener más información.

Cómo configurar Auth0

Usa la siguiente lista de tareas de alto nivel para configurar Auth0 y tu portal:

Tarea 1. Asegúrate de que haya una API de Auth0 para el servicio de Cloud Endpoints.

Tarea 2. Establece la configuración de la aplicación de Auth0.

Tarea 3. Establece la configuración de Auth0 en tu portal.

Tarea 1: Asegúrate de que haya una API de Auth0 para el servicio de Endpoints

1. Accede al Panel de Auth0.

2. En la barra de navegación izquierda, haz clic en API. Si hay un Público de API con el formato https://SERVICE_NAME, en el que SERVICE_NAME es el nombre de tu servicio de Endpoints, entonces ya creaste una API. Continúa con la tarea siguiente para establecer la configuración de la aplicación de Auth0.

   De lo contrario, crea una API:

   1. Haz clic en + Crear API.
   2. Ingresa un nombre.

   3. En el campo Identificador, ingresa una URL con el formato: https://SERVICE_NAME

      Reemplaza SERVICE_NAME con el nombre de tu servicio de Endpoints. Si tienes dudas sobre el nombre del servicio, consulta cómo obtener el nombre del servicio y el ID de configuración a fin de ver los detalles para encontrar el nombre de tu servicio de Endpoints.

   4. Haga clic en Crear.

Tarea 2: Establece la configuración de la aplicación de Auth0

1. En el Panel de Auth0, haz clic en Aplicaciones en la barra de navegación izquierda.
2. Selecciona tu aplicación de Auth0 o haz clic en + Crear aplicación para crear una nueva.

3. En la pestaña Configuración de tu aplicación, desplázate hacia abajo y agrega la URL de redireccionamiento de OAuth del portal al campo URL de devolución de llamada permitidas. La URL de redireccionamiento de OAuth de tu portal es la URL de tu portal más /oauth/redirect (por ejemplo, https://endpointsportal.example-api.example.com/oauth/redirect).

   El campo URL de devolución de llamada permitidas acepta varias URL separadas por comas. Asegúrate de que las URL que ingreses no tengan un carácter / al final.

4. Haz clic en Guardar cambios.

   Deja abierta la pestaña Configuración de Auth0, porque necesitarás la información presente allí en los siguientes pasos.

Tarea 3: Establece la configuración de Auth0 en tu portal

1. Abre otra pestaña en tu navegador y ve al portal.
2. Haz clic en Configuración.
3. En la página Configuración, haz clic en la pestaña API y selecciona tu API de la lista desplegable.

4. En la sección Configuración del Explorador de API, haz lo siguiente:

   1. Copia el valor del campo ID de cliente en el Panel de Auth0 y pégalo en el campo ID de cliente de Auth0.
   2. Copia el valor del campo Dominio en el Panel de Auth0 y pégalo en el campo Dominio de Auth0.

5. Haz clic en Guardar.

Si quieres obtener más información para configurar Auth0, consulta la descripción general del panel de Auth0 en la documentación de Auth0.