Documentation sur Oracle Cloud Infrastructure

Guide de démarrage rapide du service de passerelle d'API

Découvrez comment démarrer rapidement avec API Gateway.

A. Configurer votre location

1 Créer des groupes et des utilisateurs

Si les utilisateurs et groupes appropriés pour créer et accéder à la passerelle d'API et aux ressources de réseau n'existent pas déjà :

  1. Connectez-vous à la console en tant qu'administrateur de la location.
  2. Ouvrez le menu de navigation et sélectionnez Identité et sécurité. Sous Identité, sélectionnez Domaines.

  3. Créez un nouveau groupe en sélectionnant Groupes, puis Créer un groupe.

    Cette image présente la boîte de dialogue Créer un groupe, avec des champs Nom et Description vides.

  4. Créez un nouvel utilisateur en sélectionnant Utilisateurs, puis Créer un utilisateur.

    Cette image présente la boîte de dialogue Créer un utilisateur, avec les champs Nom, Description, Courriel et Confirmer l'adresse de courriel vides.

  5. Ajoutez un utilisateur à un groupe en sélectionnant Groupes, puis le nom du groupe, puis Ajouter un utilisateur au groupe.

    Cette image présente la boîte de dialogue Ajouter un utilisateur au groupe, avec un champ Utilisateurs vide.

Pour plus d'informations, voir instructions détaillées.

2. Créer un compartiment

Si un compartiment approprié dans lequel créer des ressources de passerelle d'API et des ressources de réseau n'existe pas déjà :

  1. Connectez-vous à la console en tant qu'administrateur de la location.
  2. Ouvrez le menu de navigation et sélectionnez Identité et sécurité. Sous Identité, sélectionnez Compartiments.

  3. Sélectionnez Créer un compartiment.

    Cette image présente la boîte de dialogue Créer un compartiment, avec des champs Nom et Description vides.

Pour plus d'informations, voir instructions détaillées.

3 Créer un VCN et des sous-réseaux

Pour garantir la haute disponibilité, vous pouvez uniquement créer des passerelles d'API dans des sous-réseaux régionaux (et non dans des sous-réseaux propres à un domaine de disponibilité). Si un VCN approprié avec un sous-réseau régional public dans lequel créer des ressources de réseau n'existe pas déjà :

  1. Connectez-vous à la console en tant qu'administrateur de la location.
  2. Ouvrez le menu de navigation , sélectionnez Service de réseau, puis Réseaux en nuage virtuels.
  3. Sélectionnez Démarrer l'assistant VCN pour créer un nouveau VCN.

  4. Dans la boîte de dialogue Start VCN Wizard, sélectionnez Create VCN with Internet Connectivity et Start VCN Wizard.

    Cette image présente la boîte de dialogue Démarrer l'Assistant VCN, avec l'option "Créer un VCN avec connectivité Internet" sélectionnée.

    En plus du VCN, le flux de travail crée un sous-réseau régional public et un sous-réseau régional privé, avec une passerelle Internet, une passerelle NAT et une passerelle de service.

  5. Entrez un nom pour le nouveau VCN et spécifiez des blocs CIDR pour le VCN, le sous-réseau régional public (doit fournir au moins 32 adresses IP gratuites) et le sous-réseau régional privé.

    Cette image présente la page Configuration du flux de travail Créer un VCN avec connectivité Internet. Les champs Bloc CIDR de VCN, Bloc CIDR de sous-réseau public et Bloc CIDR de sous-réseau privé contiennent des valeurs par défaut (respectivement 10.0.0.0/16, 10.0.0.0/24 et 10.0.1.0/24).

  6. Sélectionnez Suivant pour vérifier les détails que vous avez entrés pour le nouveau VCN et sélectionnez Créer pour le créer. Une fois le VCN créé, sélectionnez Voir le réseau en nuage virtuel pour voir le nouveau VCN et les sous-réseaux qui ont été créés.

    Cette image présente la page Réviser et créer du flux de travail Créer un VCN avec connectivité Internet, avec toutes les ressources affichées comme ayant été créées. Le bouton Voir le réseau en nuage virtuel s'affiche.

    La passerelle d'API communique sur le port 443, qui n'est pas ouvert par défaut. Vous devez ajouter une nouvelle règle entrante avec état pour le sous-réseau régional public pour permettre le trafic sur le port 443.

  7. Sélectionnez le nom du sous-réseau régional public, puis le nom de la liste de sécurité par défaut, puis sélectionnez Ajouter des règles de trafic entrant. Spécifiez les données suivantes :
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Intervalle de ports sources : Tous
    • Intervalle de ports de destination : 443
    Cette image présente la boîte de dialogue Ajouter des règles de trafic entrant, avec des valeurs par défaut dans tous les champs.
  8. Sélectionnez Ajouter des règles entrantes pour ajouter la nouvelle règle à la liste de sécurité par défaut.

Pour plus d'informations, voir instructions détaillées.

4 Créer des politiques IAM

Si un ou plusieurs développeurs d'API ne sont pas un administrateur de location :

  1. Connectez-vous à la console en tant qu'administrateur de la location.
  2. Ouvrez le menu de navigation et sélectionnez Identité et sécurité. Sous Identité, sélectionnez Politiques.

  3. Créer des politiques pour accorder aux développeurs d'API l'accès :

    Cette image présente la page Créer une politique, avec tous les champs vides. L'option Afficher l'éditeur manuel a été sélectionnée.

    1. Créez une politique avec un énoncé pour permettre aux développeurs d'API d'accéder aux ressources connexes au service de passerelle d'API. Sélectionnez Créer une politique, spécifiez un nom et une description pour la nouvelle politique, puis sélectionnez le compartiment qui sera responsable des ressources liées au service de passerelle d'API. Utilisez l'éditeur manuel du générateur de politiques pour entrer l'énoncé de politique suivant, puis sélectionnez Créer :
      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>
    2. Créez une politique avec un énoncé pour permettre aux développeurs d'API d'accéder aux ressources de réseau. Sélectionnez Créer une politique, spécifiez un nom et une description pour la nouvelle politique, puis sélectionnez le compartiment responsable des ressources de réseau à utiliser avec la passerelle d'API. Utilisez l'éditeur manuel du générateur de politiques pour entrer l'énoncé de politique suivant, puis sélectionnez Créer :
      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

    Note : Les politiques ci-dessus sont suffisantes pour vous permettre de créer un déploiement d'API avec un élément dorsal HTTP, comme suggéré dans ce guide QuickStart. Vous pouvez entrer des politiques supplémentaires (comme décrit dans la documentation) pour permettre aux développeurs d'API de créer des déploiements d'API avec les fonctions du service des fonctions pour OCI comme éléments dorsaux, et pour permettre aux passerelles d'API de s'authentifier auprès d'un serveur de cache afin d'extraire les données de réponse mises en cache.

Pour plus d'informations, voir instructions détaillées.

B. Créer, déployer et appeler votre API

1 Créer votre première passerelle d'API
  1. Connectez-vous à la console en tant que développeur de passerelle d'API, ouvrez le menu de navigation et sélectionnez Services de développement. Sous Gestion d'API, sélectionnez Passerelles.
  2. Sélectionnez Créer une passerelle et spécifiez :
    • un nom pour la nouvelle passerelle, par exemple acme-api-gateway
    • le type de la nouvelle passerelle Publique
    • le nom du compartiment dans lequel créer les ressources du service de passerelle d'API
    • le nom du VCN à utiliser avec la passerelle d'API
    • le nom du sous-réseau régional public dans le VCN
    Cette image présente la boîte de dialogue Créer une passerelle, avec tous les champs vides par défaut, à l'exception du champ Type qui est réglé à Public par défaut.
  3. Sélectionnez Créer.

    Lorsque la nouvelle passerelle d'API a été créée, elle s'affiche comme Actif dans la liste de la page Passerelles.

Pour plus d'informations, voir instructions détaillées.

2 Créer votre premier déploiement d'API
  1. Dans la page Passerelles de la console, sélectionnez le nom de la passerelle d'API que vous avez créée précédemment.
  2. Sous Ressources, sélectionnez Déploiements, puis Créer un déploiement.

  3. Sélectionnez À partir de zéro et dans la section Informations de base, spécifiez les données suivantes :

    • un nom pour le nouveau déploiement d'API, par exemple acme-api-deployment
    • un préfixe de chemin à ajouter au chemin de chaque route contenue dans le déploiement d'API, par exemple /v1
    • le compartiment dans lequel créer le nouveau déploiement d'API

    Cette image présente la page Informations de base du flux de travail Créer un déploiement, avec l'option À partir de zéro sélectionnée. Les autres champs sont vides par défaut.

  4. Sélectionnez Suivant et, dans la section Route 1, spécifiez :

    • un chemin, par exemple /hello
    • une méthode acceptée par le service dorsal, par exemple GET
    • le type du service dorsal et les détails associés. Pour plus de commodité, spécifiez le type HTTP et entrez une API publique comme URL de l'élément dorsal (par exemple, https://api.weather.gov).

    Cette image présente la page Routes du flux de travail Créer un déploiement, avec tous les champs vides par défaut.

  5. Sélectionnez Suivant pour vérifier les détails que vous avez entrés pour le nouveau déploiement d'API, puis sélectionnez Créer pour le créer.

    Cette image présente la page Réviser du flux de travail Créer un déploiement. Dans la section Informations de base, le champ Nom contient acme-api-deployment et le champ Préfixe de chemin contient /v1. Dans la section Logging Policy, le champ Execution Log Level contient Information.

    Lorsque le nouveau déploiement d'API a été créé, il est affiché comme Actif dans la liste des déploiements d'API.

  6. Lorsque le déploiement d'API est actif, passez à la tâche suivante.

Pour plus d'informations, voir Instructions détaillées.

3 Appeler votre première API

  1. Dans la liste des déploiements d'API, sélectionnez Copier à côté du point d'extrémité du nouveau déploiement d'API que vous venez de créer pour copier le point d'extrémité.

  2. Ouvrez une fenêtre de terminal et appelez l'API en entrant :

    curl -k -X GET <deployment-endpoint>

    où <deployment-endpoint> est le point d'extrémité que vous avez copié à l'étape précédente. Par exemple, https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/hello

Félicitations! Vous venez de créer votre première passerelle d'API et votre premier déploiement d'API, et vous avez appelé votre première API à l'aide du service de passerelle d'API!

Pour plus d'informations, voir instructions détaillées.

4. Étape suivante

Maintenant que vous avez créé, déployé et appelé une fonction d'API, découvrez comment :

Vous avez terminé!