Suivez les étapes ci-dessous pour créer et déployer un proxy d'API de test. Enfin, testez le proxy d'API en lui envoyant une requête HTTP.
Créer et déployer un proxy d'API
Autorisations requises pour cette tâche
La création et le déploiement de proxys nécessitent un ensemble minimal d'autorisations.
Si vous disposez du rôle d'administrateur de l'organisation Apigee, vous pouvez effectuer cette tâche.
Pour en savoir plus sur les autres rôles que vous pouvez utiliser, consultez la page sur les rôles Apigee.
Le processus de provisionnement pour Apigee ne crée et ne déploie pas automatiquement un proxy d'API pour vous. Vous devez créer et déployer un proxy manuellement.
Interface utilisateur d'Apigee dans la console Cloud
Assurez-vous que le nom de votre organisation est sélectionné dans le menu déroulant situé dans l'angle supérieur gauche de l'interface utilisateur. Le nom de l'organisation est identique à celui de votre projet Google Cloud.
Dans le volet de navigation de gauche, cliquez sur Développement du proxy > Proxys d'API.
Cliquez sur + Créer.
La page Créer un proxy s'ouvre.
Dans la zone Modèle de proxy, sélectionnez Proxy inverse (le plus courant).
À l'étape 1 : Détails du proxy, configurez votre proxy avec les valeurs suivantes :
Nom du paramètre
Valeur
Nom du proxy
hello-world
Chemin de base
/hello-world
Cible (API existante)
mocktarget.apigee.net
Cliquez sur Suivant.
Dans Étape 2 : Déployer (facultatif) :
Environnements de déploiement : facultatif. Cochez les cases correspondant aux environnements dans lesquels déployer votre proxy.
Si vous préférez ne pas déployer le proxy à ce stade, laissez le champ Environnements de déploiement vide. Vous pourrez toujours déployer le proxy ultérieurement.
Compte de service : facultatif. Associez un compte de service à votre déploiement pour permettre à votre proxy d'accéder aux services Google Cloud, comme spécifié dans le rôle et les autorisations du compte de service.
Cliquez sur Créer.
Votre proxy d'API est créé et déployé dans l'environnement sélectionné.
La page Récapitulatif du proxy correspondant au proxy que vous venez de créer s'affiche.
Une coche verte sous État indique que le proxy a bien été déployé. Si le proxy n'est pas déployé, consultez la section Déployer un proxy d'API et suivez les étapes pour le déployer manuellement.
Dans le volet de navigation de gauche, sélectionnez Gestion > Environnements > Groupes d'environnements.
Copiez le nom d'hôte de votre groupe d'environnements. Vous utiliserez ce nom d'hôte pour appeler le proxy d'API lors des étapes suivantes.
Assurez-vous que le nom de votre organisation est sélectionné dans le menu déroulant situé dans l'angle supérieur gauche de l'interface utilisateur. Le nom de l'organisation est identique à celui de votre projet Google Cloud.
Dans la vue principale, cliquez sur Proxys d'API.
Dans la liste déroulante Sélectionner un environnement, sélectionnez un environnement.
Cliquez sur Créer.
Cliquez sur Inverser le proxy (le plus courant).
Sur la page Détails du proxy, configurez votre proxy avec les paramètres suivants :
Nom du paramètre
Valeur
Nom
hello-world
Chemin de base
/hello-world
Cible (API existante)
https://mocktarget.apigee.net
Cliquez sur Suivant.
Sur la page Règles communes, sous Sécurité : Autorisation, sélectionnez Accès libre (aucune autorisation).
Cliquez sur Suivant.
Sur la page Résumé, sous Déploiement facultatif, sélectionnez l'environnement dans lequel déployer le proxy.
Cliquez sur Create and deploy (Créer et déployer).
Votre proxy d'API est créé et déployé dans l'environnement sélectionné.
Cliquez sur Accéder à la liste des proxys. Une coche verte sous État indique que le proxy a bien été déployé. Si le proxy n'est pas déployé, consultez la section Déployer un proxy d'API et suivez les étapes pour le déployer manuellement.
Dans le volet de navigation de gauche, sélectionnez Administrateur > Environnements > Groupes.
Cliquez sur Afficher dans la console Google Cloud.
Copiez le nom d'hôte de votre groupe d'environnements. Vous utiliserez ce nom d'hôte pour appeler le proxy d'API lors des étapes suivantes.
Configurez une entrée DNS pour votre hôte. Pour ce faire, deux options s'offrent à vous :
Au niveau de votre bureau d'enregistrement, créez un enregistrement A pointant vers le nom d'hôte de votre groupe d'environnements pour l'adresse IP indiquée sur la page de l'assistant sous Configurer les paramètres DNS. Par exemple, si votre nom d'hôte est sales.example.com et que l'adresse IP est 10.23.0.2, faites pointer l'enregistrement pour sales.example.com vers l'adresse 10.23.0.2.
Utilisez Cloud DNS pour mapper une URL à une adresse IP.
Testez le proxy d'API en envoyant la requête suivante dans une fenêtre de terminal :
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/04 (UTC)."],[[["\u003cp\u003eThis page provides instructions for creating and deploying a test API proxy in Apigee or Apigee hybrid environments, which can be done using either the Apigee UI in the Cloud console or the classic Apigee UI.\u003c/p\u003e\n"],["\u003cp\u003eCreating and deploying API proxies requires specific permissions, notably the Apigee Org Admin role, but alternative roles are detailed in the Apigee roles documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves configuring a reverse proxy with a specified name, base path, and target API, then optionally deploying it to selected environments, with the created proxy being displayed in the Proxy Summary page.\u003c/p\u003e\n"],["\u003cp\u003eAfter deployment, you can test the API proxy by sending an HTTP request to it, either with internal or external access, by setting up a DNS entry and using the provided \u003ccode\u003ecurl\u003c/code\u003e command with the correct environment group hostname.\u003c/p\u003e\n"],["\u003cp\u003eThe page also suggests several next steps, such as taking a tour of Apigee tutorials for learning about guarding against traffic spikes and getting a detailed view of the request/response flow.\u003c/p\u003e\n"]]],[],null,["# Recommended next steps\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\nWhat you're doing in this step\n------------------------------\n\n\nFollow the steps below to create and deploy a test API proxy. Finally,\ntest the API proxy by sending an HTTP request to it.\n\nCreate and deploy an API proxy\n------------------------------\n\n#### Permissions required for this task\n\n\nCreating and deploying proxies requires a minimum set of permissions.\nIf you have the Apigee Org Admin role, you can complete this task.\nTo learn about other roles you can employ, see\n[Apigee roles](/apigee/docs/api-platform/system-administration/apigee-roles).\n\nThe provisioning process for Apigee does not automatically create\nand deploy an API proxy for you. You must create and deploy a proxy manually. \n\n### Apigee UI in the Cloud console\n\nTo create and deploy your first proxy:\n\n1. In the Google Cloud console, go to the **Proxy development \\\u003e API proxies** page.\n\n [Go to API proxies](https://console.cloud.google.com/apigee/proxies)\n2. Be sure that your organization name is selected from the project picker in the **Google Cloud** pane. The organization name is the same as your Google Cloud project name.\n3. Click **+ Create** .\n\n The **Create a proxy** page opens.\n4. In the **Proxy template** box, select **Reverse proxy (most common)**.\n5. In **Step 1: Proxy details** , configure your proxy with the following values:\n\n6. Click **Next**.\n7. In **Step 2: Deploy (optional)** :\n - **Deployment environments** : Optional. Use the checkboxes to select one or more environments in which to deploy your proxy. If you prefer not to deploy the proxy at this point, leave the **Deployment environments** field empty. You can always deploy the proxy later.\n - **Service Account**: Optional. Attach a service account to your deployment to enable your proxy to access Google Cloud services, as specified in the service account's role and permissions.\n8. Click **Create** .\n\n Your new API proxy is created and deployed in the selected environment.\n | **Note:**The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.\n9. The **Proxy summary** page for your newly created proxy opens. A green check mark under **Status** indicates that the proxy was successfully deployed. If the proxy is not deployed, see [Deploying an API proxy](/apigee/docs/api-platform/deploy/ui-deploy-new) and follow the steps to deploy it manually.\n10. In the left navigation pane, select **Management \\\u003e Environments \\\u003e Environment Groups**.\n11. Copy the hostname for your environment group. You'll use this hostname to call the API proxy in the next steps.\n\n### Classic Apigee\n\nTo create and deploy your first proxy:\n\n1. Sign in to the [Apigee UI](https://apigee.google.com).\n2. Be sure that your organization name is selected from the drop-down menu in the upper left corner of the UI. The organization name is the same as your Google Cloud project name.\n3. Click **API Proxies** in the main view.\n4. From the **Select Environment** drop-down list, select an environment.\n5. Click **Create new**.\n6. Click **Reverse proxy (most common)**.\n7. In the **Proxy details** page, configure your proxy with the following values:\n\n8. Click **Next**.\n9. In the **Common policies** page, under **Security:\n Authorization** select **Pass through (no authorization)**.\n10. Click **Next**.\n11. On the **Summary** page, under **Optional Deployment**, select the environment in which to deploy the proxy.\n12. Click **Create and deploy** .\n\n Your new API proxy is created\n and deployed in the selected environment.\n | **Note:**The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.\n13. Click **Go to proxy list** . A green check mark under **Status** indicates that the proxy was successfully deployed. If the proxy is not deployed, see [Deploying an API proxy](/apigee/docs/api-platform/deploy/ui-deploy-new) and follow the steps to deploy it manually.\n14. In the left navigation pane, select **Admin \\\u003e Environments \\\u003e Groups**.\n15. Click **View in Google Cloud console**.\n16. Copy the hostname for your environment group. You'll use this hostname to call the API proxy in the next steps.\n17. Close the Google Cloud console.\n\nCall the proxy with internal access\n-----------------------------------\n\nIf you allowed *internal* access in\n[Step 4: Customize access routing](/apigee/docs/api-platform/get-started/configure-routing), follow the instructions in:\n[Calling an API proxy with internal-only access](/apigee/docs/api-platform/get-started/accessing-internal-proxies).\n\nCall the proxy with external access\n-----------------------------------\n\n\nIf you allowed *external* access in\n[Step 4: Customize access routing](/apigee/docs/api-platform/get-started/configure-routing), follow these steps:\n\n1. Set up a DNS entry for your host. Here are two ways to accomplish this task:\n - At your registrar, create an A record pointing your environment group hostname to the IP shown on the wizard page under **Configure DNS** . For example, if your hostname is `sales.example.com` and the IP is 10.23.0.2, then point the record for `sales.example.com` to the address `10.23.0.2`.\n - Use Google [Cloud DNS](/dns/docs) to map a URL to an IP address.\n 2. Test the API proxy by sending the following request in a terminal window: **Note:** DNS changes are published immediately, but may take time to propagate. Because of this delay, you may have to wait up to an hour before you can call the sample proxy. \n\n ```\n curl -v -H \"Host:YOUR_ENV_GROUP_HOSTNAME\" \\\n https://YOUR_INSTANCE_IP_OR_DNS/hello-world\n ```\n\n Where:\n - The value of the `Host` header (\u003cvar translate=\"no\"\u003eYOUR_ENV_GROUP_HOSTNAME\u003c/var\u003e) is the hostname from the **Environments \\\u003e Environment Groups** page.\n\n A successful request returns the string: `Hello, Guest!`.\n If your request is not successful, see [Troubleshooting](/apigee/docs/api-platform/get-started/troubleshooting-install).\n\nNext steps\n----------\n\n- [Take a tour](/apigee/docs/api-platform/get-started/tutorials) of the Apigee tutorials, including:\n - [Guarding against sudden\n traffic spikes](/apigee/docs/api-platform/tutorials/add-spike-arrest).\n - [Getting a detailed view of\n the request/response flow](/apigee/docs/api-platform/tutorials/view-with-trace)."]]
