Documentation sur Oracle Cloud Infrastructure

Appel d'une API déployée sur une passerelle d'API

Découvrez comment appeler une API que vous avez déjà déployée sur une passerelle d'API avec le service de passerelle d'API.

Ayant déployé une API sur une passerelle d'API, vous pouvez appeler l'API déployée.

Conseil

Lors de l'assemblage de la commande cURL décrite dans cette rubrique, vous pouvez rapidement obtenir la valeur de la chaîne https://<gateway-hostname>/<deployment-path-prefix> en tant que point d'extrémité du déploiement d'API à l'aide des composants suivants :

  • La console, en allant à la page Détails de la passerelle et en sélectionnant Copier à côté du point d'extrémité du déploiement d'API.
  • L'API, à l'aide de l'opération GetDeployments.

Utilisation de cURL

Pour appeler une API déployée sur une passerelle d'API :

  1. Ouvrez la fenêtre d'un terminal et entrez une commande cURL similaire à la suivante, qui convient pour l'API déployée :

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

    où :

    • <method> est une méthode valide pour l'API déployée (par exemple, GET, PUT).

    • <gateway-hostname> est un nom de domaine généré automatiquement au format <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com, où :

      • <gateway-identifier> est la chaîne de caractères qui identifie la passerelle d'API. Par exemple, lak...sjd (abrégé pour une meilleure lisibilité).
      • <region-identifier> est l'identificateur de la région dans laquelle la passerelle d'API a été créée. Voir Disponibilité par région.

      Par exemple, lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

      Utilisez la console ou l'API pour rechercher le nom de domaine à utiliser comme valeur de <gateway-hostname>.

    • /<deployment-path-prefix> est le préfixe ajouté au chemin de chaque route du déploiement d'API. Notez que le préfixe de chemin de déploiement dans la demande :

      • Peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes).
      • Peut inclure des caractères alphanumériques en majuscules et en minuscules.
      • peut inclure les caractères spéciaux $ - _ . + ! * ' ( ) , % ; : @ & =
      • Ne peut pas inclure des paramètres et des caractères génériques.
      • Doit correspondre exactement au préfixe du chemin de déploiement défini pour le déploiement d'API (voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API).

      Utilisez la console ou l'API pour rechercher le préfixe de chemin à utiliser comme valeur de <deployment-path-prefix>.

    • /<api-route-path> est le chemin vers une route particulière définie dans la spécification de déploiement d'API. Notez que le chemin de routage dans la demande :

      • Est relatif au préfixe du chemin de déploiement.
      • Doit être une barre oblique unique.
      • Peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes) et peut se terminer par une barre oblique.
      • Peut inclure des caractères alphanumériques en majuscules et en minuscules.
      • peut inclure les caractères spéciaux $ - _ . + ! * ' ( ) , % ; : @ & =
      • Ne doit pas correspondre exactement au chemin de routage défini dans la spécification de déploiement d'API, à condition que ce dernier inclut un paramètre de chemin avec ou sans caractère générique (voir Ajout de paramètres de chemin et de caractères génériques aux chemins de routage).

      Utilisez la console ou l'API pour rechercher le chemin à utiliser comme valeur de <api-route-path>.

    Par exemple :

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

    Si l'élément dorsal de la passerelle d'API est une fonction sans serveur qui accepte des paramètres, incluez ces paramètres dans l'appel à l'API. Par exemple :

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