Utiliser les exemples de proxys d'API

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

Prérequis

Vous aurez besoin d'un compte sur http://enterprise.apigee.com. Vous pouvez vous inscrire pour un compte d'essai à l'adresse http://accounts.apigee.com/accounts/sign_up.

Pour utiliser des exemples, vous devez également disposer des éléments suivants:

Outil Description
Git Les exemples se trouvent sur GitHub. Si Git n'est pas installé, consultez Instructions de configuration de Git sur GitHub Si vous ne souhaitez pas installer Git, vous pouvez parcourir les fichiers et télécharger un fichier ZIP à l'adresse https://github.com/apigee/api-platform-samples.
Python

Python est requis pour exécuter l'outil de déploiement Apigee. Python est présent dans la plupart des systèmes Linux sur un Mac, sur un ordinateur Windows sur lequel Cygwin est installé, etc.

Pour obtenir Python, reportez-vous à la Page de téléchargement Python

curl Les exemples de scripts de configuration utilisent également curl. Assurez-vous que curl est installé et disponible sur votre chemin (exécutez la commande which curl pour voir s'il est disponible sur votre système).
dos2unix Si vous exécutez Cygwin sous Windows, vous aurez peut-être également besoin du fichier dos2unix utilitaire. (Le programme d'installation de Cygwin vous permet d'installer l'utilitaire.)

Télécharger les exemples

Pour obtenir les exemples de fichiers, utilisez git clone comme indiqué dans l'exemple suivant:

git clone https://github.com/apigee/api-platform-samples.git

Importer et déployer l'exemple d'API proxys

Importez et déployez les exemples à partir de la ligne de commande:

  1. Après avoir téléchargé les exemples, accédez au répertoire /setup, comme le montre l'exemple suivant:
    cd setup
  2. Dans le répertoire /setup, recherchez le fichier setenv.sh.
  3. Modifiez ce fichier pour indiquer votre organisation, l'adresse e-mail associée à votre nom d'utilisateur, et l'environnement (production ou test) dans lequel vous souhaitez déployer les proxys d'API.
  4. Après avoir modifié setenv.sh, exécutez la commande suivante:
    sh deploy_all.sh

    Ce script déploie tous les exemples de proxy d'API dans votre organisation. (Le processus prend entre 3 et 4 minutes.) Suivez les invites pour déployer les produits d'API, les développeurs et les applications (utilisés pour OAuth).

  5. Une fois le script de déploiement terminé, accédez au répertoire "sample-proxies". Dans répertoire sample-proxies, vous trouverez un répertoire par exemple de proxy. Dans chaque est un fichier README.md avec des informations sur l'exécution de l'exemple, ainsi que deux scripts qui apporter de petites modifications aux exemples, les déployer, puis les appeler pour voir l'effet de vos modifications: <ph type="x-smartling-placeholder">
      </ph>
    • invoke.sh: exécutez ce script pour appeler la version déployée de l'API. proxy.
    • deploy.sh: exécutez ce script pour déployer le proxy d'API après avoir créé une des modifications.

Appeler les exemples de proxys d'API

Chaque exemple de proxy est associé à un script shell qui peut être utilisé pour appeler le proxy d'API. après son déploiement.

À partir du répertoire /sample-proxies/proxy_name, exécutez la commande suivantes:

sh invoke.sh

Cette action appelle le proxy qui s'exécute dans l'environnement de test de votre organisation.

Dépannage

Pour obtenir des informations de dépannage, consultez les pages suivantes:

Modifier et réutiliser les exemples de proxys d'API

Les exemples d'utilisation de proxys sont généralement utilisés pour modifier, déployer et appeler. Cela vous permet de créer de petites modifications, puis de voir leur effet sur le message de réponse.

Pour modifier un exemple de proxy d'API de sorte qu'il pointe vers un autre service de backend, modifiez la XML de configuration à l'emplacement suivant:

/apiproxy/targets/target_name.xml

Par exemple, pour faire pointer l'exemple de clé API vers votre propre service de backend, localisez ce fichier:

/apikey/apiproxy/targets/default.xml

Si la configuration par défaut pointe vers http://mocktarget.apigee.net, par exemple:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

et que votre service de backend est disponible à l'adresse http://api.myproject.com/, modifiez la configuration comme suit:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Après avoir enregistré vos modifications, déployez le proxy d'API comme indiqué dans l'exemple suivant:

sh deploy.sh

Les autres proxys d'API peuvent être modifiés de la même manière afin d'utiliser la fonctionnalité de proxy d'API par rapport à vos services cibles existants. Dans certains cas, cependant, le comportement du proxy de l'API dépend des formats de message spécifiques, les proxys peuvent donc avoir besoin de modifications de configuration supplémentaires.