Utiliser les exemples de proxys d'API

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X. info

Prérequis

Vous devez disposer d'un compte sur http://enterprise.apigee.com. Vous pouvez vous inscrire pour obtenir un compte d'essai sur http://accounts.apigee.com/accounts/sign_up.

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

Outil Description
Git Les exemples sont disponibles sur GitHub. Si Git n'est pas installé, veuillez consulter 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 à partir de 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 une machine Windows avec Cygwin installé et dans de nombreux autres emplacements.

Pour obtenir Python, veuillez consulter la page de téléchargement de Python.
curl Les scripts de configuration de l'exemple utilisent également curl. Assurez-vous que curl est installé et disponible dans votre chemin d'accès (exécutez la commande which curl pour vérifier s'il 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 illustré 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. Une fois les exemples téléchargés, accédez au répertoire /setup, comme illustré 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 (production ou test) dans lequel vous souhaitez déployer les proxys d'API.
  4. Une fois que vous avez 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. (Le processus prend 3 à 4 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. Dans le répertoire sample-proxies, vous trouverez un répertoire par exemple de proxy. Chaque répertoire contient un fichier README.md avec des informations sur l'exécution de l'exemple, ainsi que deux scripts qui vous aident à apporter de petites modifications aux exemples, à les déployer, puis à les appeler pour voir l'effet de votre modification :
    • 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 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 suivante :

sh invoke.sh

Cela 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 ressources suivantes :

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

L'utilisation typique des exemples de proxys consiste à les modifier, à les déployer et à les appeler. Cela vous permet d'apporter de petites modifications, puis de voir 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 que l'exemple de clé API pointe vers votre propre service de backend, recherchez le fichier suivant :

/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 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>

Une fois vos modifications enregistrées, déployez le proxy d'API comme illustré 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, toutefois, le comportement du proxy d'API dépend de formats de messages spécifiques. Les proxys peuvent donc nécessiter des modifications de configuration supplémentaires.