Installer et configurer l'outil Oracle Mobile Hub pour le déploiement d'API personnalisées

Vous pouvez télécharger et configurer des outils supplémentaires pour déployer des API personnalisées dans Oracle Mobile Hub.

Installer les outils Node.js

Lorsque vous téléchargez le kit SDK à partir d'Oracle Technology Network (OTN), vous pouvez télécharger le fichier omce-tools-vXX.X.X, qui comprend un script Node.js que vous pouvez utiliser pour déployer vos applications vers Oracle Mobile Hub.

Pour installer l'outil Node.js dans votre projet, procédez comme suit :

  1. Téléchargez le fichier ZIP omce-tools-vXX.X.X et décompressez le fichier Zip dans un répertoire
  2. Sur votre ordinateur, ouvrez une fenêtre de terminal (il peut s'avérer nécessaire d'exécuter cette commande en tant qu'administrateur), puis accédez au répertoire omce-tools/node-configurations.
  3. Déterminez la configuration de noeud à utiliser pour l'API personnalisée que vous testez. Utilisez 6.10 pour la version de noeud 6.10.0 ou une version compatible, et 8.9 pour la version de noeud 8.9.4 ou la version compatible. La configuration de noeud par défaut pour Oracle Mobile Hub est 8.9.
  4. Sélectionnez le répertoire de la configuration de noeud à utiliser : `6.10` ou `8.9`
  5. Exécutez la commande suivante :
    npm install
  6. Sélectionnez le répertoire omce-tools.
  7. Exécutez la commande :
    npm install -g

    Cette commande rend les outils disponibles globalement dans votre environnement local. La version Node.js et le gestionnaire de packages npm doivent être installés avant l'exécution de cette commande

  8. Définissez la variable d'environnement NODE_PATH sur le répertoire node_modules pour la configuration de noeud à utiliser ou sur path/omce-tools/node-configurations/8.9/node_modules.
  9. Pour vérifier si l'installation a réussi, exécutez la commande :
    omce-test --version

Télécharger un environnement JavaScript pour une API personnalisée

Une fois que vous avez créé l'API personnalisée, vous pouvez télécharger un échafaudage basé sur le document RAML de votre API, puis l'utiliser en tant que démarrage rapide pour implémenter l'API personnalisée.

L'échafaudage se présente sous la forme d'un module de noeud, c'est-à-dire les composants-clés du fichier JavaScript principal contenant les méthodes stub de chaque adresse (ressource et méthode HTTP) et d'un fichier package.json qui sert de manifeste pour le module.

Pour télécharger l'échafaudage, procédez comme suit :

  1. Cliquez sur Il s'agit d'une image du menu de la barre latérale. pour ouvrir le menu latéral, cliquez sur Développement, puis sur API.
  2. Ouvrez l'API à télécharger.
  3. Dans la zone de navigation de gauche du concepteur d'API, cliquez sur Implémentations.
  4. Cliquez sur Scaffold JavaScript pour télécharger le fichier ZIP.
  5. Sur votre système, décompressez le fichier téléchargé.

Si vous modifiez l'API ultérieurement, vous pouvez télécharger un nouvel échafaudage en fonction des adresses mises à jour. Toutefois, tout codage que vous avez peut-être effectué et téléchargé précédemment ne sera pas reflété dans le nouvel échafaudage.

Configurer toolsConfig.jssur le fichier

Après avoir téléchargé un fichier scaffold basé sur le document RAML de l'API, vous pouvez configurer manuellement un fichier JSON (JavaScript Notation) appelé toolsConfig.json.

Oracle Mobile Hub utilise un fichier toolsConfig.json qui contient les informations de déploiement pour une API personnalisée. Un toolsConfig.json par défaut est généré lorsque vous créez une API personnalisée et que vous téléchargez l'échafaudage. Pour configurer le fichier toolsConfig.json, procédez comme suit :

  1. Ouvrir la page Paramètres de back-end mobile dans Oracle Mobile Hub
  2. Notez les informations de la page Paramètres.
    La page Paramètres contient des informations telles que les types d'authentification (HTTP de base, destinataire OAuth) et les URL d'environnement.
  3. A l'aide d'un éditeur de texte, mettez à jour le fichier toolsConfig.json avec les valeurs de la page Paramètres dans Oracle Mobile Hub.
        "backend":{
            "backendId":"<YOUR_BACKEND_ID>",
            "backendName":"<YOUR_BACKEND_NAME>",
            "backendVersion":"<YOUR_BACKEND_VERSION>",
            "authorization":{
                "anonymousKey":"<BACKEND_ANONYMOUS_KEY>",
                "clientId":"<BACKEND_CLIENT_ID>",
                "clientSecret":"<BACKEND_CLIENT_SECRET>"
            }
        },
  4. Ouvrez la page Développement.
  5. Cliquez sur Détails de l'instance.
  6. Notez les valeurs Id client de l'application membre de l'équipe et Clé secrète du client de l'application membre de l'équipe.
  7. Mettez à jour le fichier toolsConfig.json avec ces valeurs.
        "tools":{
            ...,
            "authorization":{
                "clientId":"<TEAM_MEMBER_APP_CLIENT_ID>",
                "clientSecret":"<TEAM_MEMBER_APP_CLIENT_SECRET>"
            }
        },
  8. (Facultatif) Pour vérifier que le fichier toolsConfig.json est correct, vous pouvez effectuer un test de déploiement. Ouvrez une fenêtre de terminal, accédez au répertoire omce-tools et déployez l'API personnalisée à l'aide de la commande :
    node omce-deploy toolsConfig.json
    Après avoir exécuté cette commande, vous êtes invité à saisir vos informations d'identification Oracle Mobile Hub. Si le fichier toolsConfig.json est correct, un message indiquant Deployment completed successfully est affiché. Vous pouvez utiliser cette commande pour déployer ultérieurement votre API personnalisée.