Installare e configurare gli strumenti di Oracle Mobile Hub per la distribuzione delle interfacce API personalizzate

È possibile scaricare e configurare strumenti aggiuntivi per distribuire API personalizzate in Oracle Mobile Hub.

Installare Node.js Tooling

Quando si scarica il kit SDK da Oracle Technology Network (OTN), è possibile scaricare il file omce-tools-vXX.X.X, che include uno script Node.js utilizzabile per distribuire le applicazioni in Oracle Mobile Hub

Per installare gli strumenti Node.js nel progetto, procedere nel seguente modo.

  1. Scaricare il file zip omce-tools-vXX.X.X e decomprimere il file ZIP in una directory.
  2. Nel computer, aprire una finestra del terminale (potrebbe essere necessario eseguire questo comando come utente amministratore), quindi passare alla directory omce-tools/node-configurations.
  3. Determinare la configurazione nodo da utilizzare per l'API personalizzata di cui si sta eseguendo il test. Utilizzare 6.10 per 6.10.0 o compatibile con la versione del nodo e 8.9 per 8.9.4 o compatibile con la versione del nodo. La configurazione nodo predefinita per Oracle Mobile Hub è 8.9.
  4. Passare alla directory per la configurazione del nodo che si desidera utilizzare: `6.10` o `8.9`
  5. Eseguire il comando seguente:
    npm install
  6. Passare alla directory omce-tools.
  7. Eseguire il comando:
    npm install -g

    Questo comando rende gli strumenti disponibili globalmente nell'ambiente locale. Prima di eseguire questo comando, è necessario che sia installato Node.js e npm Package Manager

  8. Impostare la variabile di ambiente NODE_PATH sulla directory node_modules per la configurazione del nodo da utilizzare o su path/omce-tools/node-configurations/8.9/node_modules.
  9. Per verificare se l'installazione è riuscita, eseguire il comando:
    omce-test --version

Scarica uno Scaffold JavaScript per un'interfaccia API personalizzata

Dopo aver creato l'interfaccia API personalizzata, è possibile scaricare uno scaffold basato sul documento RAML dell'interfaccia API, quindi utilizzarlo come collegamento rapido per implementare l'interfaccia API personalizzata.

Lo scaffold viene fornito sotto forma di modulo di nodo, ovvero i componenti chiave del file JavaScript principale che contiene metodi stub per ogni endpoint (risorsa più metodo HTTP) e un file package.json, che serve come file manifest per il modulo.

Per scaricare lo scaffold, effettuare le operazioni riportate di seguito.

  1. Fare clic su Questa è un'immagine del menu della barra laterale. per aprire il menu laterale, fare clic su Sviluppo, quindi su API.
  2. Aprire l'API che si desidera scaricare.
  3. Nell'area di navigazione sinistra di API Designer, fare clic su Implementazioni.
  4. Fare clic su Scaffold JavaScript per scaricare il file ZIP.
  5. Estrarre il file scaricato nel sistema.

Se in seguito si modifica l'interfaccia API, è possibile scaricare un nuovo scaffold in base agli endpoint aggiornati. Tuttavia, qualsiasi codifica effettuata e caricata in precedenza non verrà riportata nel nuovo scaffold.

Configurare toolsConfig.jsnel file

Dopo aver scaricato un file scaffold basato sul documento RAML dell'interfaccia API, è possibile configurare manualmente un file JavaScript Notation (JSON) denominato toolsConfig.json.

Oracle Mobile Hub utilizza un file toolsConfig.json che contiene le informazioni di distribuzione per un'interfaccia API personalizzata. Viene generato il file toolsConfig.json predefinito quando si crea un'interfaccia API personalizzata e si scarica lo scaffold. Per configurare il file toolsConfig.json:

  1. Apre la pagina Impostazioni backend mobile in Oracle Mobile Hub
  2. Annotare le informazioni nella pagina Impostazioni.
    La pagina Impostazioni contiene informazioni quali i tipi di autenticazione (HTTP Basic, OAuth Consumer) e gli URL dell'ambiente.
  3. Utilizzando un editor di testo, aggiornare il file toolsConfig.json con i valori nella pagina Impostazioni di 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. Aprire la pagina Sviluppo.
  5. Fare clic su Dettagli istanza.
  6. Prendere nota dei valori Id client applicazione membro team e Segreto client applicazione membro team.
  7. Aggiornare il file toolsConfig.json con questi valori.
        "tools":{
            ...,
            "authorization":{
                "clientId":"<TEAM_MEMBER_APP_CLIENT_ID>",
                "clientSecret":"<TEAM_MEMBER_APP_CLIENT_SECRET>"
            }
        },
  8. (Facoltativo) Per verificare che toolsConfig.json sia corretto, è possibile eseguire un test della distribuzione. Aprire una finestra terminale, passare alla directory omce-tools e distribuire l'API personalizzata utilizzando il comando:
    node omce-deploy toolsConfig.json
    Dopo aver eseguito questo comando, vengono richieste le credenziali per Oracle Mobile Hub. Se il file toolsConfig.json è corretto, viene visualizzato un messaggio con l'indicazione Deployment completed successfully. È possibile utilizzare questo comando per distribuire l'interfaccia API personalizzata in futuro.