Cette page a été traduite par l'API Cloud Translation.

Tutoriels sur les cibles hébergées

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

Les tutoriels suivants expliquent comment déployer des applications Node.js sur Edge à l'aide de Cibles hébergées, un environnement d'exécution Node.js natif hébergé par Apigee.

Les tutoriels vous permettent d'effectuer les tâches suivantes:

Déployer une application Node.js sur des cibles hébergées à l'aide de l'interface utilisateur Edge
Déploiement d'une application Node.js sur des cibles hébergées à partir de votre ordinateur de développement local.
Migration d'un proxy existant avec une mise en œuvre cible Edge Node.js traditionnelle vers des cibles hébergées.

Déployer une application Node.js sur des cibles hébergées à l'aide de l'interface utilisateur Edge

Dans ce tutoriel, vous allez déployer une application Node.js simple sur des cibles hébergées à l'aide de l'interface utilisateur Edge. À l'issue de ce tutoriel, vous comprendrez la structure et le contenu de base d'un proxy de cibles hébergées, et apprendrez à accéder aux fichiers journaux de déploiement et de compilation.

Accédez à apigee.com/edge.
Saisissez vos identifiants de connexion Apigee pour vous connecter.

Créer un proxy

Dans le menu de navigation latéral, sélectionnez Développer > Proxys d'API.
Cliquez sur + Proxy.
Sur la page "Créer un proxy", sélectionnez Cible hébergée.
Cliquez sur Suivant.
Dans le champ "Nom du proxy", saisissez hello-hosted-targets.
Les noms des proxys ne doivent pas contenir d'espaces.
Assurez-vous que l'option Exemple "Hello World" est sélectionnée.
Cliquez sur Suivant.
Sur la page "Security" (Sécurité), sélectionnez Pass through (none) (Accès libre [aucune]) pour l'autorisation.
Cliquez sur Suivant.
Cliquez sur Suivant.
Sur la page "Créer", assurez-vous que l'environnement de test est sélectionné. Notez que le type de proxy est Hosted Cibles (Cibles hébergées).
Cliquez sur Build and Deploy (Compiler et déployer). Le déploiement du proxy peut prendre quelques instants.
Une fois le proxy déployé, cliquez sur Afficher le proxy hello-Hosted-targets en bas de la page.
Appelez le proxy d'API. Le moyen le plus simple est d'accéder à l'onglet Trace, de démarrer une session de suivi et de cliquer sur Envoyer. Vous devez recevoir l'état 200 avec la réponse suivante :
```
{"date":"2018-09-26T14:23:04.550Z","msg":"Hello, World!"}
```

Examiner le proxy

Dans l'interface utilisateur Edge, cliquez sur l'onglet Develop (Développer).
Dans le navigateur, sélectionnez par défaut sous "Points de terminaison cibles".
Dans l'éditeur de code, notez qu'il y a un élément enfant <HostedTarget/> vide sous l'élément <TargetEndpoint>. Cette balise vide est obligatoire. Il indique à Edge que la cible du proxy est une application déployée dans l'environnement "Hosted Targets" (Cibles hébergées).
Dans le navigateur, notez le contenu de la section Scripts. Les fichiers de l'application Node.js sont répertoriés sous le libellé Hosted (hébergé).

Dans l'interface utilisateur Edge, examinez les fichiers répertoriés sous hébergé dans Scripts:

Le fichier app.yaml contient des informations de configuration. Par exemple, vous pouvez ajouter des variables d'environnement qui seront disponibles pour l'application Node.js au moment de l'exécution. Il n'est pas nécessaire de modifier ce fichier pour cet exemple.
Le projet ne contient pas de dossier node_modules. Aucun dossier node_modules n'est requis. Edge exécute la commande npm install pour vous lorsque l'application Node.js est déployée. Il récupère les dépendances à partir de package.json. Le seul moment où vous devez fournir explicitement node_modules est si vous disposez de modules personnalisés qui ne sont pas disponibles via npm.
Le fichier index.js est le fichier principal de l'application Node.js.
Si votre application comporte des dépendances de module, elles doivent être répertoriées dans le fichier package.json.

Afficher les fichiers journaux

Les fichiers journaux d'application peuvent être utiles pour déboguer des problèmes survenant pendant la phase de compilation ainsi que lors de l'exécution.

Dans l'interface utilisateur d'Edge, cliquez sur l'onglet Développer.
Pour afficher le journal de compilation, cliquez sur Journaux de compilation.
Pour afficher le journal de déploiement, cliquez sur Journaux d'exécution.

Consultez également la section Accéder aux fichiers journaux.

Résumé

Vous avez déployé une application Node.js simple dans l'environnement Hosted Targets et l'avez testée dans l'interface utilisateur Edge.
Vous avez appris qu'un proxy Hosted Targets nécessite une balise vide spéciale appelée <HostedTarget/> dans le point de terminaison cible.
Vous avez appris qu'Edge charge automatiquement les dépendances du module pour vous et que ces dépendances doivent être répertoriées dans le fichier package.json.
Vous avez également appris à vérifier les fichiers journaux de compilation et d'exécution.

Déployer Node.js depuis votre système vers Edge

Cette section explique comment déployer une application Node.js autonome à partir de votre système local vers des cibles hébergées à l'aide de apigeetool. L'utilitaire apigeetool regroupe l'application Node.js dans un nouveau proxy de cibles hébergées et la déploie dans Edge.

Installer apigeetool

L'utilisation d'apigeetool est recommandée aux développeurs pour déployer du code proxy dans Edge. Pour installer apigeetool, exécutez la commande NPM suivante:

npm install -g apigeetool

Créer l'application Node.js

Pour vous faciliter la tâche, nous vous fournissons le code d'une application Node.js simple.

Créez un répertoire pour l'application Node.js, puis appelez le répertoire node-hosted-express.
cd pour accéder au nouveau répertoire.
Créez un fichier nommé index.js et copiez-y ce code.
Notez que l'application nécessite le module d'expression. Lors du déploiement, les cibles hébergées exécutent npm install pour importer ce module externe. Vous n'avez pas besoin d'inclure le répertoire node_modules lors du déploiement sur Edge. Vous ne devez fournir explicitement node_modules que si vous disposez de modules personnalisés qui ne sont pas disponibles via npm.

var express = require('express')
var app = express()

app.get('/', function(req, res) {
    res.json({
        hello: "Hello World!"
    })
})

app.get('/hello/:name', function(req, res) {
    var name = req.params.name
    res.json({
        hello: "hello " + name
    })
})

var server = app.listen(process.env.PORT || 9000, function() {
    console.log('Listening on port %d', server.address().port)
})

Créez un fichier nommé package.json et copiez-y ce code. Notez que le module Express est répertorié en tant que dépendance.

{
    "name": "hello-world",
    "version": "1.0.0",
    "main": "index.js",
    "scripts": {
        "start": "node index.js --use_strict"
    },
    "author": "",
    "license": "",
    "dependencies": {
        "express": "^4.16.0"
    }
}

Créez un fichier nommé app.yaml et copiez-y le code suivant :

runtime: node
runtimeVersion: 8
application: my-express-app
env:
  - name: NODE_ENV
    value: production
  - name: LOG_LEVEL
    value: 3

Assurez-vous que votre répertoire se présente comme suit :
```
ls
app.yaml index.js package.json
```

Examen de la structure de répertoire requise pour le code de l'application

Votre application Node.js doit avoir la même structure qu'une application Node.js standard. Toutefois, assurez-vous de respecter ces exigences avant de procéder au déploiement avec apigeetool sur Edge:

Le fichier manifeste app.yaml est obligatoire et doit se trouver dans le répertoire racine de votre application. Pour en savoir plus sur ce fichier, consultez la section Fichier manifeste.
Un fichier package.json est requis. Il doit répertorier toutes les dépendances requises par votre application.
Il n'est pas obligatoire de spécifier un dossier node_modules. Edge exécute la commande npm install pour vous lorsque l'application Node.js est déployée. Il récupère les dépendances à partir de package.json. Vous n'avez besoin de fournir explicitement node_modules, c'est-à-dire si vous disposez de modules personnalisés qui ne sont pas disponibles via npm.

Déployer le proxy

Dans un terminal, utilisez la commande cd pour accéder au répertoire racine de votre application Node.js.
Exécutez apigeetool avec la commande deployhosttarget:

apigeetool regroupe automatiquement l'application Node.js dans un proxy d'API et la déploie dans l'environnement "Hosted Targets" (Cibles hébergées) sur Apigee Edge. Le déploiement peut prendre quelques minutes.

apigeetool deployhostedtarget -o org -e env -n proxy-name -b /node-hosted-express -u username

où -n est le nom que vous voulez donner au nouveau proxy. Il doit être unique au sein de l'organisation. Les caractères que vous êtes autorisé à utiliser dans le nom sont limités aux éléments suivants : a-z0-9._\-$%

Exemple :

apigeetool deployhostedtarget -o myorg -e test -n node-hosted-express -b /node-hosted-express -u jdoe@apigee.com

Pour en savoir plus sur l'utilisation de apigeetool, consultez la page https://github.com/apigee/apigeetool-node.

Tester le proxy

Vous pouvez tester le proxy avec une commande cURL, avec un client REST tel que Postman ou dans l'interface utilisateur d'Edge dans l'outil Trace. Voici un exemple de commande cURL.

curl http://myorg-test.apigee.net/node-hosted-express
     {"date":1506992197427,"msg":"hello-world"}

Obtenir les journaux de compilation

Les journaux de compilation affichent la sortie liée au déploiement et à la compilation de l'application Node.js. Consultez également la section Fichiers journaux.

apigeetool getlogs -u username -o org -e env --hosted-build -n proxy-name

Exemple :

apigeetool getlogs -u jdoe@apigee.com -o myorg -e test --hosted-build -n node-hosted-express

Obtenir les journaux d'exécution

Les journaux d'exécution affichent la sortie liée à l'application en cours d'exécution. Ils sont limités à l'environnement et renvoient les journaux de la version de proxy actuellement déployée. Consultez également l'article Fichiers journaux.

apigeetool getlogs -u username -o org -e env --hosted-runtime -n proxy-name

Exemple :

apigeetool getlogs -u jdoe@apigee.com -o myorg -e test --hosted-runtime -n node-hosted-express

Afficher le proxy dans l'UI Edge

Après un déploiement réussi, vous pouvez afficher et modifier votre proxy dans la partie Proxys d'API de l'interface utilisateur Edge.

Migrer un proxy Node.js existant vers un proxy de cibles hébergées

Cette section explique comment migrer manuellement un proxy d'API Edge existant qui utilise la mise en œuvre cible Node.js traditionnelle vers des cibles hébergées. Elle explique également comment déployer le proxy une fois la migration effectuée.

Les étapes de migration préservent la structure, les règles, les flux et les autres éléments de configuration du proxy d'API. Vous pouvez effectuer la migration en quatre étapes, comme indiqué ci-dessous, puis déployer le proxy migré avec apigeetool.

Étape 1 : Ajustez la structure du fichier du proxy

Pour ajuster la structure des fichiers, le proxy d'API doit se trouver sur votre système de fichiers local. Si le proxy est déployé sur Edge, vous devez le télécharger avant de continuer. Dans la configuration traditionnelle, le "bundle" du proxy Edge qui inclut le code Node.js suit cette structure de fichiers. Le code de l'application Node.js est placé dans le répertoire resources/node :

apiproxy/
    policies/
    proxies/
    targets/
    resources/
      node/
        Your application code

Pour les cibles hébergées, vous devez placer le répertoire racine de votre application Node.js dans un répertoire appelé resources/hosted. Il vous suffit de créer un répertoire nommé resources/hosted et de déplacer le contenu de resources/node dans celui-ci. Vous pouvez ensuite supprimer le répertoire resources/node.

apiproxy/
     policies/
     proxies/
     targets/
     resources/
       hosted/
         Your application code

Étape 2: Ajoutez le fichier manifeste

Créez un fichier manifeste appelé app.yaml et placez-le dans le répertoire apiproxy/resources/hosted.

Voici un exemple de fichier app.yaml. Il spécifie que l'environnement d'exécution est Node.js (obligatoire). Il crée également une variable d'environnement dans l'environnement d'exécution (une variable à laquelle l'application Node.js peut accéder). La variable d'environnement est facultative et n'est présentée ici qu'à titre d'exemple. Pour en savoir plus et obtenir des exemples, consultez la section Fichier manifeste.

runtime: node
  env:
    - name: NODE_ENV
      value: production

L'exemple suivant montre une structure de projet Node.js qui se trouve à l'emplacement approprié dans le proxy pour le déploiement des cibles hébergées :

apiproxy/
   resources/
      hosted/
        index.js
        node_modules/
        app.yaml
        package.json

Le répertoire node_modules n'est pas obligatoire. Edge effectuera une npm install lorsque l'application sera déployée. Toutefois, si votre application utilise des modules privés ou personnalisés non disponibles via npm, vous pouvez les inclure dans le répertoire node_modules et ils seront déployés avec l'application.

Étape 3 : Assurez-vous de disposer d'un fichier package.json

Dans les mandataires Node.js Edge traditionnels, package.json était facultatif. Toutefois, pour les cibles hébergées, vous devez en fournir une dans le répertoire apiproxy/resources/hosted. Veillez à spécifier toutes les dépendances requises pour votre application dans ce fichier.

Étape 4: Modifiez le point de terminaison cible du proxy

Un proxy Node.js traditionnel nécessite la présence d'un tag nommé <ScriptTarget> dans le fichier du point de terminaison cible (généralement /apiproxy/targets/default.xml). Pour les cibles hébergées, vous devez ajouter une balise vide appelée <HostedTarget/>. Si le fichier contient une balise ScriptTarget, il vous suffit de la supprimer. Exemple :

    <?xml version="1.0" encoding="UTF-8"?>
    <TargetEndpoint name="default">
       <Description />
       <FaultRules />
       <PreFlow name="PreFlow">
          <Request />
          <Response />
       </PreFlow>
       <PostFlow name="PostFlow">
          <Request />
          <Response />
       </PostFlow>
       <Flows />
       <HostedTarget />
    </TargetEndpoint>

Déployer le proxy

Vous pouvez maintenant déployer le proxy à l'aide de la commande apigeetool deployproxy.

cd vers le répertoire racine de votre proxy : /apiproxy
Utilisez cette commande pour déployer le proxy :
Si vous remplacez un proxy Edge Node.js "traditionnel" actuellement, veillez à utiliser le même nom de proxy dans la commande suivante (paramètre -n) que le proxy déployé. L'utilitaire apigeetool désinstalle le proxy existant et déploie le nouveau proxy Hosted Targets.

apigeetool deployproxy -u username -o org -e env -n proxy-name -d .

Exemple :

apigeetool deployproxy -u jdoe -o docs -e test -n hello-world -d .

Pour en savoir plus sur l'utilisation de apigeetool, consultez la page https://github.com/apigee/apigeetool-node/blob/master/README.md.

Tester le proxy

Vous pouvez tester le proxy avec une commande cURL, avec un client REST tel que Postman, ou dans l'interface utilisateur Edge de l'outil Trace. Voici un exemple de commande cURL :

curl http://myorg-test.apigee.net/hello-world
Hello,World!

Tutoriels sur les cibles hébergées

Déployer une application Node.js sur des cibles hébergées à l'aide de l'interface utilisateur Edge

Se connecter

Créer un proxy

Examiner le proxy

Afficher les fichiers journaux

Résumé

Déployer Node.js depuis votre système vers Edge

Installer apigeetool

Créer l'application Node.js

Examen de la structure de répertoire requise pour le code de l'application

Déployer le proxy

Tester le proxy

Obtenir les journaux de compilation

Obtenir les journaux d'exécution

Afficher le proxy dans l'UI Edge

Migrer un proxy Node.js existant vers un proxy de cibles hébergées

Étape 1 : Ajustez la structure du fichier du proxy

Étape 2: Ajoutez le fichier manifeste

Étape 3 : Assurez-vous de disposer d'un fichier package.json

Étape 4: Modifiez le point de terminaison cible du proxy

Déployer le proxy

Tester le proxy