Documentación de Oracle Cloud Infrastructure

Llamada a una API desplegada en un gateway de API

Descubra cómo llamar a una API que haya desplegado anteriormente en un gateway de API con el servicio de gateway de API.

Tras desplegar una API en un gateway de API, puede llamar a la API desplegada.

Consejo

Al ensamblar el comando curl descrito en este tema, puede obtener rápidamente el valor de la cadena https://<gateway-hostname>/<deployment-path-prefix> como punto final del despliegue de API mediante:

  • La consola, si va a la página Detalles de gateway y hace clic en Copiar, junto al punto final del despliegue de API.
  • La API, mediante la operación GetDeployments.

Uso de curl

Para llamar a una API desplegada en un gateway de API:

  1. Abra una ventana de terminal y escriba un comando cURL similar al que se muestra a continuación que sea adecuado para la API desplegada:

    curl -k -X <method> https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

    donde:

    • <method> es un método válido para la API desplegada (por ejemplo, GET, PUT).

    • <gateway-hostname> es un nombre de dominio generado automáticamente con formato <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com, donde:

      • <gateway-identifier> es la cadena de caracteres que identifica el gateway de API. Por ejemplo, lak...sjd (abreviado para lectura).
      • <region-identifier> es el identificador de la región en la que se ha creado el gateway de API. Consulte Disponibilidad por región.

      Por ejemplo, lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

      Utilice la consola o la API para averiguar el nombre de dominio que utilizar como valor de <gateway-hostname>.

    • /<deployment-path-prefix> es el prefijo agregado a la ruta de acceso de cada ruta del despliegue de API. Tenga en cuenta que el prefijo de ruta de acceso de despliegue de la solicitud:

      • Puede contener varias barras inclinadas (siempre que no sean adyacentes).
      • Puede incluir caracteres alfanuméricos en mayúscula y minúscula.
      • Puede incluir los caracteres especiales $ - _ . + ! * ' ( ) , % ; : @ & = .
      • No puede incluir parámetros ni comodines.
      • Debe coincidir exactamente con el prefijo de ruta de acceso de despliegue definido para el despliegue de API (consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API).

      Utilice la consola o la API para averiguar el prefijo de ruta de acceso que se utiliza como valor de <deployment-path-prefix>.

    • /<api-route-path> es la ruta de acceso a una ruta concreta definida en la especificación de despliegue de API. Tenga en cuenta que la ruta de acceso de la solicitud:

      • Es relativa al prefijo de ruta de acceso de despliegue.
      • Puede ser una única barra inclinada.
      • Puede contener varias barras inclinadas (siempre que no sean adyacentes) y puede terminar con una barra inclinada.
      • Puede incluir caracteres alfanuméricos en mayúscula y minúscula.
      • Puede incluir los caracteres especiales $ - _ . + ! * ' ( ) , % ; : @ & = .
      • No es necesario que coincida exactamente con la ruta definida en la especificación de despliegue de API, siempre que la ruta de acceso de la especificación de despliegue incluya un parámetro de ruta con o sin comodín (consulte Agregación de parámetros de ruta y comodines a rutas de acceso).

      Utilice la consola o la API para averiguar la ruta de acceso que utilizar como valor de <api-route-path>.

    Por ejemplo:

    curl -k -X GET https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/marketing/hello/

    Si el backend de gateway de API es una función sin servidor que acepta parámetros, incluya esos parámetros en la llamada a la API. Por ejemplo:

    curl -k -X POST https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/marketing/hello/ -d "name=john"