Créez un proxy dans l'UI d'Apigee ou à l'aide de l'API, comme décrit dans les sections suivantes.
Champs principaux du proxy d'API
Suivez ces consignes lorsque vous créez un proxy d'API :
Champ
Description
Nom de proxy d'API
Nom affiché pour votre API. Indiquez des caractères alphanumériques, des tirets (-) ou des traits de soulignement (_).
Chemin de base du proxy d'API
Fragment d'URI qui apparaît après l'adresse http://[host] ou https://[host] du proxy d'API. Apigee utilise l'URI de chemin de base pour faire correspondre et acheminer les messages de requête entrantes vers le proxy d'API approprié.
Utiliser des caractères génériques dans les chemins de base
Utilisez un ou plusieurs caractères génériques dans les chemins d'accès de base du proxy d'API pour assurer la pérennité de vos proxys d'API.
Nous autorisons la spécification d'un seul caractère générique * entre deux barres obliques / : /*/.
Par exemple, un chemin de base de /team/*/members permet aux clients d'appeler https://[host]/team/blue/members et https://[host]/team/green/members sans que vous ayez besoin de créer de proxys d'API pour gérer les nouvelles équipes.
Vous pouvez remplacer n'importe quel nombre de jetons dans le chemin de base en suivant ce modèle.
Les autres modèles, y compris /**, /something* ou /*something, ne sont pas acceptés.
Description
(Facultatif) Description du proxy d'API.
URL cible/URL cible de backend
URL (y compris HTTP ou HTTPS) du service de backend que ce proxy d'API appelle.
Espace
(Facultatif) Si Apigee Spaces est activé pour votre organisation, vous pouvez associer le proxy d'API à un espace.
Pour en savoir plus, consultez Présentation d'Apigee Spaces.
Étapes à suivre pour créer un proxy d'API
Pour créer un proxy d'API à l'aide de l'interface utilisateur ou des API :
Apigee dans la console Cloud
Pour créer un proxy simple dans Apigee dans la console Cloud, procédez comme suit :
Dans la console Google Cloud , accédez à la page Développement de proxys > Proxys d'API.
Dans le volet Créer un proxy, sous Modèle de proxy, sélectionnez Proxy inverse (le plus courant).
Sous Détails du proxy, saisissez les informations suivantes :
Nom du proxy : saisissez un nom pour le proxy, tel que myproxy.
Chemin de base : défini automatiquement sur la valeur que vous saisissez pour Proxy name. Le chemin de base fait partie de l'URL utilisée pour envoyer des requêtes à votre API. Apigee utilise l'URL pour mettre en correspondance et acheminer les requêtes entrantes vers le proxy d'API approprié.
Description (facultatif) : saisissez une description de votre nouveau proxy d'API, par exemple "Test Apigee avec un proxy simple".
Target (Existing API) Target (API existante) : saisissez https://mocktarget.apigee.net.
Cela définit l'URL cible qu'Apigee appelle pour une requête adressée au proxy d'API. Le service "mocktarget" est hébergé sur Apigee et renvoie des données simples. Il ne nécessite aucune clé d'API ni jeton d'accès.
Espace (facultatif) : si Apigee Spaces est activé pour votre organisation, vous pouvez associer le proxy d'API à un espace sélectionné dans la liste des options disponibles.
Pour en savoir plus, consultez Présentation d'Apigee Spaces.
Cliquez sur Suivant.
Déployer (facultatif) :
Environnements de déploiement : facultatif. Cochez les cases pour sélectionner un ou plusieurs 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.
Apigee crée le proxy et affiche un résumé des détails du proxy dans la vue Récapitulatif du proxy.
Si vous avez choisi de déployer le proxy, la section Déploiements affiche le numéro de Révision, soit 1 lors du premier déploiement. La colonne État affiche les environnements dans lesquels le proxy est déployé avec un indicateur d'état vert.
Apigee classique
Pour créer un proxy d'API simple dans l'interface utilisateur classique d'Apigee :
Dans la liste déroulante Environnement, sélectionnez l'environnement dans lequel vous souhaitez créer un proxy d'API.
L'interface utilisateur hybride affiche la liste des proxys d'API pour cet environnement. Si vous n'avez pas encore créé de proxy, la liste est vide.
Cliquez sur Créer.
L'assistant de création de proxy démarre.
Cliquez sur Inverser le proxy (le plus courant).
La page Informations sur le proxy s'affiche.
Configurez votre proxy avec les paramètres suivants :
Nom : saisissez getstarted. Si un proxy portant ce nom existe déjà, choisissez-en un autre.
Base Path (Chemin de base) : laissez cette valeur définie sur /getstarted. Le chemin de base fait partie de l'URL utilisée pour envoyer des requêtes à votre API. Apigee utilise l'URL pour mettre en correspondance et acheminer les requêtes entrantes vers le proxy d'API approprié.
Description (facultatif) : saisissez une description du nouveau proxy d'API, telle que Get started API proxy.
Target (Existing API) Target (API existante) : saisissez https://mocktarget.apigee.net. Cela définit l'URL cible qu'Apigee appelle pour une requête adressée au proxy d'API. Le service "mocktarget" est hébergé sur Apigee et renvoie des données simples. Il ne nécessite aucune clé d'API ni jeton d'accès.
Les détails de votre proxy API doivent se présenter comme suit :
Cliquez sur Suivant.
Dans la vue Common policies (Règles courantes), sous Security: Authorization (Sécurité : Autorisation), sélectionnez Pass through (no authorization) (Stratégie directe (sans autorisation).
Cliquez sur Suivant.
Sur la page Summary (Résumé), sélectionnez les environnements de déploiement, si vous le souhaitez, puis 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 Edit proxy (Modifier le proxy) pour afficher l'onglet "Overview" (Présentation) dans l'éditeur de proxy.
Dans la liste des proxys d'API, l'état de déploiement du proxy getstarted est vert pour l'environnement test.
API Apigee
Créez un proxy d'API dans votre organisation Apigee en envoyant une requête POST à la ressource suivante :
Vous devez définir le nom du proxy d'API à l'aide du paramètre de requête name. Limitez les caractères utilisés dans le nom aux éléments suivants : A-Za-z0-9._\-$ %
Vous pouvez éventuellement importer un groupe de configuration de proxy d'API en procédant comme suit :
Définissez le paramètre de requête action sur import
Définissez l'en-tête Content-type sur multipart/form-data
Transmettez le nom du groupe de configuration de proxy d'API sur votre système de fichiers local
L'exemple suivant montre comment créer un proxy d'API en important un groupe de configuration de proxy d'API (helloworld-config.zip) sur votre système de fichiers local à l'aide de l'API.
Pour plus d'informations sur la création d'un proxy d'API, consultez la méthode apis.create dans l'API Apigee. Pour afficher toutes les méthodes disponibles pour les proxys d'API, consultez la page Proxys d'API.
Étapes suivantes
Après avoir créé un proxy d'API simple, effectuez l'une des opérations suivantes :
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/05 (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/05 (UTC)."],[[["\u003cp\u003eThis page outlines the process of creating API proxies in Apigee and Apigee hybrid, which includes instructions for using the Apigee UI, API, and Cloud console.\u003c/p\u003e\n"],["\u003cp\u003eWhen creating an API proxy, key fields include the proxy name, which must be unique within the organization and consist of alphanumeric characters, dashes, or underscores, and the base path, which defines the URI for routing incoming requests, and must also be unique.\u003c/p\u003e\n"],["\u003cp\u003eWildcards (\u003ccode\u003e/*/\u003c/code\u003e) can be used in API proxy base paths to allow flexibility for future expansions without creating new API proxies, such as \u003ccode\u003ehttps://[host]/team/blue/members\u003c/code\u003e and \u003ccode\u003ehttps://[host]/team/green/members\u003c/code\u003e from basepath \u003ccode\u003e/team/*/members\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAPI proxies can be created through the Apigee UI in the Cloud console or the classic Apigee UI, and by sending a POST request to the Apigee API, offering flexibility in proxy creation methods.\u003c/p\u003e\n"],["\u003cp\u003eAfter creating a simple API proxy, you can add policies, security, and other features of the Apigee platform, as well as deploy it to your cluster.\u003c/p\u003e\n"]]],[],null,["# Creating an API proxy\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\n| **Note:** In environments enabled for [archive deployments](/apigee/docs/api-platform/fundamentals/environments-overview#deployment-types), you cannot develop API proxies using the Apigee UI, API, or gcloud. To develop API proxies for archive deployments using Apigee in VS Code,see [Developing API proxies](/apigee/docs/api-platform/local-development/vscode/develop-apiproxies) using Apigee in VS Code.\n\nCreate a proxy in the Apigee UI, or using the API, as described in the following sections.\n\nAPI proxy primary fields\n------------------------\n\nFollow these guidelines when creating an API proxy:\n\nSteps to create an API proxy\n----------------------------\n\nTo create an API proxy using the UI or APIs: \n\n### Apigee in Cloud console\n\nTo create a proxy in Apigee in Cloud console:\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)\n| **Note:** If you see the **Welcome to Apigee API Management** page, you need to [provision\n| your Apigee organization](/apigee/docs/api-platform/get-started/provisioning-intro) before proceeding further.\n|\n| \u003cbr /\u003e\n|\n| After you have provisioned Apigee, close the UI and reopen the\n| [Apigee UI in Cloud console](https://console.cloud.google.com/apigee).\n2. In the **API Proxies** pane, click **+ Create**.\n3. In the **Create a proxy** pane, under **Proxy template** , select **Reverse proxy (Most common)**.\n4. Under **Proxy details** , enter the following:\n - **Proxy name:** Enter a name for the proxy, such as `myproxy`.\n - **Base Path** : Automatically set to the value you enter for `Proxy name`. The **Base\n Path** is part of the URL used to make requests to your API. Apigee uses the URL to match and route incoming requests to the appropriate API proxy.\n - **Description (Optional)**: Enter a description for your new API proxy, such as \"Testing Apigee with a simple proxy.\"\n - **Target (Existing API):** Enter `https://mocktarget.apigee.net`. This defines the target URL that Apigee invokes on a request to the API proxy. The mocktarget service is hosted at Apigee and returns simple data. It requires no API key or access token.\n - **Space (Optional)** : If your organization has Apigee Spaces enabled, you can associate the API proxy with a Space selected from the list of available options. For more information, see [Apigee Spaces overview](/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).\n - Click **Next**.\n5. **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.\n6. Click **Create**.\n\nApigee creates the new proxy and displays a summary of the proxy details in the\n**Proxy summary** view.\n\nIf you choose to deploy the proxy, the **Deployments** section displays the **Revision**\nnumber, which is 1 when you first deploy. The **Status** column displays the\nenvironments in which the proxy is deployed with a green status indicator.\n\n### Classic Apigee\n\nTo create a simple API proxy in the classic Apigee UI:\n\n1. Sign in to the [Apigee UI](https://apigee.google.com).\n2. Click **API Proxies** in the main view.\n3. From the **Environment** drop-down list, select the environment in which you want to create a new API proxy.\n\n The hybrid UI displays a list of API proxies for that environment. If you haven't created any\n proxies yet, the list is empty.\n4. Click **Create New** .\n\n The Create Proxy wizard starts.\n5. Click **Reverse proxy (most common)** .\n\n The **Proxy details** page is displayed.\n6. Configure your proxy with the following settings:\n - **Name:** Enter `getstarted`. If a proxy already exists with this name, choose a different name.\n - **Base Path:** Leave this set to `/getstarted`. The **Base\n Path** is part of the URL used to make requests to your API. Apigee uses the URL to match and route incoming requests to the appropriate API proxy.\n - **Description** (Optional): Enter a description for your new API proxy, such as `Get started API proxy`.\n - **Target (Existing API):** Enter `https://mocktarget.apigee.net`. This defines the target URL that Apigee invokes on a request to the API proxy. The mocktarget service is hosted at Apigee and returns simple data. It requires no API key or access token.\n\n Your API proxy's details should look like the following:\n\n7. Click **Next**.\n8. In the **Common policies** view, under **Security:\n Authorization** select **Pass through (no authorization)** .\n\n9. Click **Next**.\n10. On the **Summary** page, select the deployment environments, if desired, and click **Create and deploy** .\n\n | **Note:** If you don't select an environment below **Optional Deployment** , the button at the lower right is just labeled **Create**.\n | **Note:** After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision.\n |\n | For this reason, you may choose to create the API proxy without deploying it to any\n | environment. You can edit the API proxy and deploy the API proxy later, as described in\n | [Next steps](#next-steps).\n\n Your new API proxy is created\n and deployed in the selected environment.\n\n11. Click **Edit proxy** to display the Overview tab in the Proxy Editor.\n12. \n\n\nIn the API proxies list, the `getstarted` API proxy deployment status is **green** for the `test` environment.\n\n### Apigee API\n\nCreate an API proxy in your Apigee organization by issuing a `POST`\nrequest to the following resource: \n\n```\nhttps://apigee.googleapis.com/v1/organizations/$ORG/apis\n```\n\nYou must define the name of the API proxy using the `name` query parameter. Restrict\nthe characters used in the name to the following: `A-Za-z0-9._\\-$ %`\n\nOptionally, you can import an API proxy configuration bundle by performing the following steps:\n\n- Set the `action` query parameter to `import`\n- Set the `Content-type` header to `multipart/form-data`\n- Pass the name of the API proxy configuration bundle on your local file system\n\nThe following example demonstrates how to create an API proxy by importing an API proxy\nconfiguration bundle (`helloworld-config.zip`) on your local file system using the\nAPI. \n\n```\ncurl \"https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import\" \\\n -X POST \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-type: multipart/form-data\" \\\n -F \"file=@helloworld-config.zip\"\n```\n\nWhere `$TOKEN` is set to your OAuth 2.0 access token, as described in\n[Obtaining an OAuth 2.0 access token](/apigee/docs/api-platform/get-started/api-get-started#oauth20). For information about the `curl` options used in this example, see\n[Using curl](/apigee/docs/api-platform/get-started/api-get-started#curl). For a description of environment variables you can use, see\n[Setting\nenvironment variables for Apigee API requests](/apigee/docs/api-platform/get-started/api-get-started#api-environment-variables).\n\nThe following provides an example of the response output: \n\n```carbon\n{\n \"basepaths\": [\n \"/helloworld\"\n ],\n \"configurationVersion\": {\n \"majorVersion\": 4\n },\n \"createdAt\": \"1559145292799\",\n \"displayName\": \"helloworld\",\n \"entityMetaDataAsProperties\": {\n \"bundle_type\": \"zip\",\n \"subType\": \"Proxy\",\n \"lastModifiedAt\": \"1559145292799\",\n \"createdAt\": \"1559145292799\"\n },\n \"lastModifiedAt\": \"1559145292799\",\n \"name\": \"helloworld\",\n \"policies\": [\n \"verify-api-key\",\n \"remove-query-param-apikey\",\n \"OAuth-v20-1\"\n ],\n \"proxies\": [\n \"default\"\n ],\n \"proxyEndpoints\": [\n \"default\"\n ],\n \"resourceFiles\": {},\n \"targetEndpoints\": [\n \"default\"\n ],\n \"targets\": [\n \"default\"\n ],\n \"type\": \"Application\",\n \"revision\": \"1\",\n \"description\": \"Hello world\"\n}\n```\n\nFor more information on creating an API proxy, see the [`apis.create` method](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apis/create)\nin the Apigee API. To see all the methods available for API proxies, see the [API proxies API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apis).\n\nNext steps\n----------\n\nAfter you create a simple API proxy, you typically do one of the following:\n\n- Add policies, security, and other features of the Apigee platform, as described in [Understanding APIs and\n API proxies](/apigee/docs/api-platform/fundamentals/understanding-apis-and-api-proxies).\n- Deploy it to your cluster, as described in [Deploy an API proxy](/apigee/docs/api-platform/deploy/ui-deploy-new)."]]
