Transfiere datos hacia y desde el servicio de backend

Cuando un cliente de API realiza una solicitud a la API implementada en API Gateway, el cliente puede pasar toda la siguiente información, como parte, de la solicitud:

  • Solicita encabezados
  • Parámetros de consulta
  • Datos de formulario
  • Cargas útiles de XML o JSON
  • Rutas de solicitud

Cuando genera su respuesta a la solicitud de API, el servicio de backend puede devolver datos al cliente de la API, incluidos los siguientes:

  • Encabezados de respuesta
  • Cargas útiles de XML o JSON

En este documento, se describe cómo se transfieren estos datos hacia y desde el servicio de backend.

¿Cómo se pasan los datos de solicitud al servicio de backend?

Todos los datos de la solicitud del cliente de API se pasan sin cambios al servicio de backend. Luego, el servicio de backend debe analizar los datos de la solicitud como parte del procesamiento de la solicitud.

¿Cómo se devuelven los datos de respuesta al cliente de la API?

Todos los datos que se reciben en la respuesta del servicio de backend se pasan sin cambios al cliente de la API. Luego, el cliente de la API debe procesar los datos que se devuelven en la respuesta.

¿Cómo se pasa la URL de la solicitud al servicio de backend?

La extensión x-google-backend controla la URL que se usa para realizar una solicitud al servicio de backend. En esta sección, se describen las opciones para configurar la URL del servicio de backend.

Establece la dirección y la ruta de acceso del servicio de backend en la especificación de OpenAPI

En la especificación de OpenAPI que usas para crear una configuración de API, utilizas la extensión x-google-backend para especificar la URL del servicio de backend. Por ejemplo, puedes especificar el servicio de backend de la siguiente manera:

Backend x-google-backend
Cloud Run Functions 
x-google-backend:
  address: https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello
Cloud Run Una de las siguientes opciones: 
  • x-google-backend:
  address: APP_URL
  • x-google-backend:
  address: DETERMINISTIC_URL
Entorno estándar de App Engine 
x-google-backend:
  address: https://PROJECT_ID.appspot.com

En estos ejemplos, se ilustra lo siguiente:

  • APP_URL especifica la URL real de tu servicio de Cloud Run (la ruta de acceso completa de la API llamada), también conocida como la URL no determinística. Por ejemplo: https://hello-abc1def2gh-uc.a.run.app.
  • DETERMINISTIC_URL es la URL determinística para el backend de tu servicio de Cloud Run.