Documentation Oracle Cloud Infrastructure

Guide de démarrage rapide API Gateway

Découvrez comment vous lancer rapidement avec API Gateway.

A. Configurez la location

1 Créer des groupes et des utilisateurs

Si les utilisateurs et groupes appropriés pour créer API Gateway et accéder aux ressources réseau n'existent pas déjà, procédez comme suit :

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

  3. Créez un 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. Pour créer un utilisateur, sélectionnez Utilisateurs, puis Créer un utilisateur.

    Cette image présente la boîte de dialogue Créer un utilisateur, avec les champs Nom, Description, E-mail et Confirmer l'e-mail vides.

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

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

Pour plus d'informations, reportez-vous à instructions détaillées.

2. Créer un compartiment

Si aucun compartiment approprié dans lequel créer des ressources et des ressources réseau API Gateway n'existe déjà :

  1. Connectez-vous à la console en tant qu'administrateur de 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, reportez-vous à instructions détaillées.

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

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

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

  4. Dans la boîte de dialogue Démarrer l'assistant VCN, sélectionnez Créer un VCN avec la connectivité Internet et sélectionnez Démarrer l'assistant VCN.

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

    Outre le VCN, le workflow 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 le nom du nouveau VCN et spécifiez les blocs CIDR pour le VCN, le sous-réseau régional public (doit fournir un minimum de 32 adresses IP gratuites) et le sous-réseau régional privé.

    Cette image présente la page Configuration du workflow 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 (10.0.0.0/16, 10.0.0.0/24 et 10.0.1.0/24 respectivement).

  6. Sélectionnez Suivant pour vérifier les détails que vous avez entrés pour le nouveau VCN, puis sélectionnez Créer pour le créer. Lorsque le VCN a été créé, sélectionnez Afficher le réseau cloud virtuel pour voir le nouveau VCN et les sous-réseaux qui ont été créés.

    Cette image présente la page Vérifier et créer du workflow Créer un VCN avec connectivité Internet, avec toutes les ressources affichées comme ayant été créées. Le bouton Afficher le réseau cloud virtuel s'affiche.

    API Gateway 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 afin d'autoriser le trafic sur le port 443.

  7. Sélectionnez le nom du sous-réseau régional public, le nom de la liste de sécurité par défaut, puis Ajouter des règles entrantes. Indiquez l'une des valeurs suivantes :
    • Type de source : CIDR
    • CIDR source : 0.0.0.0/0
    • Protocole IP : TCP
    • Plage de ports source : Tous
    • Plage de ports de destination : 443
    Cette image présente la boîte de dialogue Ajouter des règles entrantes, 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, reportez-vous à instructions détaillées.

4 Créer des stratégies 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 location.
  2. Ouvrez le menu de navigation et sélectionnez Identité et sécurité. Sous identité, sélectionnez des stratégies.

  3. Créez des stratégies pour donner aux développeurs d'API l'accès :

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

    1. Créez une stratégie avec une instruction de stratégie pour permettre aux développeurs d'API d'accéder aux ressources liées à API Gateway. Sélectionnez Créer une stratégie, indiquez le nom et la description de la nouvelle stratégie, puis sélectionnez le compartiment propriétaire des ressources liées à API Gateway. Utilisez l'éditeur manuel Policy Builder pour entrer l'instruction de stratégie suivante, puis sélectionnez Créer :
      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>
    2. Créez une stratégie avec une instruction de stratégie pour permettre aux développeurs d'API d'accéder aux ressources réseau. Sélectionnez Créer une stratégie, indiquez le nom et la description de la nouvelle stratégie, puis sélectionnez le compartiment auquel appartiennent les ressources réseau à utiliser avec API Gateway. Utilisez l'éditeur manuel Policy Builder pour entrer l'instruction de stratégie suivante, puis sélectionnez Créer :
      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

    Remarque : les stratégies ci-dessus sont suffisantes pour vous permettre de créer un déploiement d'API avec un back-end HTTP, comme suggéré dans ce guide QuickStart. Vous pouvez entrer des stratégies supplémentaires (comme décrit dans la documentation) pour permettre aux développeurs d'API de créer des déploiements d'API avec des fonctions OCI Functions en tant que back-ends, 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 en cache.

Pour plus d'informations, reportez-vous à 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 API Gateway, ouvrez le menu de navigation et sélectionnez Services de développeur. Sous Gestion des API, sélectionnez Passerelles.
  2. Sélectionnez Créer une passerelle et indiquez les éléments suivants :
    • un nom pour la nouvelle passerelle, tel que acme-api-gateway
    • le type de la nouvelle passerelle en tant que public
    • le nom du compartiment dans lequel créer des ressources API Gateway
    • le nom du VCN à utiliser avec API Gateway
    • 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 défini sur Public par défaut.
  3. Choisissez Créer.

    Une fois la passerelle d'API créée, elle apparaît comme active dans la liste de la page Passerelles.

Pour plus d'informations, reportez-vous à instructions détaillées.

2 Créer votre premier déploiement d'API
  1. Sur 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 Entièrement nouveau, puis, dans la section Informations de base, indiquez les éléments suivants :

    • un nom pour le nouveau déploiement d'API, tel que acme-api-deployment
    • un préfixe de chemin à ajouter au chemin de chaque routage contenu dans le déploiement d'API, tel que /v1
    • le compartiment dans lequel créer le déploiement d'API

    Cette image présente la page Informations de base du workflow Créer un déploiement, avec l'option A 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, indiquez les éléments suivants :

    • un chemin, tel que /hello
    • une méthode acceptée par le service back-end, telle que GET
    • le type du service back-end et les détails associés. Pour plus de commodité, indiquez le type HTTP et entrez une API publique en tant qu'URL du back-end (par exemple, https://api.weather.gov).

    Cette image présente la page Itinéraires du workflow Créer un déploiement, avec tous les champs vides par défaut.

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

    Cette image présente la page Vérifier du workflow 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 des informations.

    Une fois le déploiement d'API créé, il apparaît 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, reportez-vous aux instructions détaillées.

3 Appelez votre première API

  1. Dans la liste des déploiements d'API, sélectionnez Copier en regard de l'adresse du déploiement d'API que vous venez de créer pour copier l'adresse.

  2. Ouvrez une fenêtre de terminal et appelez l'API en saisissant ce qui suit :

    curl -k -X GET <deployment-endpoint>

    où <deployment-endpoint> est l'adresse que vous avez copiée à 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 API Gateway !

Pour plus d'informations, reportez-vous à instructions détaillées.

4. Etape suivante

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

C'est fait !