Utiliser les exemples de proxys d'API

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Conditions préalables

Vous devez disposer d'un compte sur http://enterprise.apigee.com et vous pouvez créer un compte d'essai sur la page 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 vous n'avez pas installé Git, consultez les 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 environnements Linux, sur un Mac avec XCode installé, sur un ordinateur Windows sur lequel Cygwin est installé et dans de nombreux autres endroits.

Pour obtenir Python, consultez la page de téléchargement de Python.

curl Les exemples de scripts de configuration utilisent également curl. Assurez-vous que curl est installé et disponible sur votre chemin d'accès (exécutez la commande which curl pour voir si elle est disponible sur votre système).
dos2unix Si vous exécutez Cygwin sous Windows, vous aurez peut-être également besoin de l'utilitaire dos2unix. (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 les exemples de proxys d'API

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 indiqué dans l'exemple suivant :
    cd setup
  2. Dans le répertoire /setup, recherchez le fichier setenv.sh.
  3. Modifiez ce fichier pour définir votre organisation, l'adresse e-mail associée à votre nom d'utilisateur et l'environnement (prod 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 proxys d'API dans votre organisation. Ce processus prend trois à quatre minutes. Suivez les instructions pour déployer des produits d'API, des développeurs et des applications (utilisés pour OAuth).

  5. Une fois le script de déploiement terminé, accédez au répertoire sample-proxies. Le répertoire sample-proxies contient un répertoire par exemple de proxy. Chaque répertoire contient un fichier README.md contenant des informations sur l'exécution de l'exemple, ainsi que deux scripts qui vous aideront à apporter de petites modifications aux exemples, à déployer, puis à appeler l'exemple pour voir l'effet de vos modifications :
    • invoke.sh: exécutez ce script pour appeler la version déployée du proxy d'API.
    • deploy.sh: exécutez ce script pour déployer le proxy d'API après avoir apporté des modifications.

Appeler les exemples de proxys d'API

Chaque exemple de proxy est associé à un script shell qui permet d'appeler le proxy d'API après son déploiement.

Dans le répertoire /sample-proxies/proxy_name, exécutez la commande suivante:

sh invoke.sh

Le proxy qui s'exécute dans l'environnement de test de votre organisation est alors appelé.

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 de proxys sont généralement utilisés pour modifier, déployer et appeler. Vous pouvez ainsi effectuer de petites modifications, puis observer leur effet sur le message de réponse.

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

/apiproxy/targets/target_name.xml

Par exemple, pour renvoyer 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 sur http://api.myproject.com/, modifiez la configuration pour qu'elle se présente 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

Vous pouvez modifier les autres proxys d'API de la même manière afin d'utiliser la fonctionnalité de proxy d'API sur vos services cibles existants. Toutefois, dans certains cas, le comportement des proxys d'API dépend de formats de message spécifiques. Par conséquent, les proxys peuvent nécessiter des modifications de configuration supplémentaires.