カスタムApiのデプロイ用のOracle Mobile Hubツールのインストールおよび構成

Oracle Mobile Hubでカスタムapiをデプロイするための追加ツールをダウンロードして構成できます。

Node.jsツールをインストール

Oracle Technology Network (OTN)からSDKをダウンロードする際、Oracle Mobile Hubにアプリケーションをデプロイするために使用できるNode.jsスクリプトが含まれているomce-tools-vXX.X.Xファイルをダウンロードするオプションがあります。

プロジェクトにNode.jsツールをインストールする手順は次のとおりです。

  1. omce-tools-vXX.X.X zipファイルをダウンロードし、Zipファイルを圧縮解除してディレクトリに展開します。
  2. マシン上でターミナル・ウィンドウを開き(このコマンドを管理ユーザーとして実行する必要がある場合があります)、omce-tools/node-configurationsディレクトリに変更します。
  3. テストするカスタムAPIに使用する必要があるノード構成を決定します。6.10は、ノード・バージョンの6.10.0または互換性を維持し、ノード・バージョンの8.9.4または互換性に8.9を使用するために使用します。Oracle Mobile Hubのデフォルトのノード構成は8.9.です
  4. 使用するノード構成のディレクトリ(6.10または8.9)への変更
  5. 次のコマンドを実行します。
    npm install
  6. omce-toolsディレクトリに移動します。
  7. コマンドを実行します:
    npm install -g

    このコマンドによって、ツールはローカル環境でグローバルに使用できるようになります。このコマンドを実行する前に、Node.jsおよびnpmパッケージ・マネージャをインストールする必要があります。

  8. 環境変数NODE_PATHを、使用するノード構成またはpath/omce-tools/node-configurations/8.9/node_modulesに対するnode_modulesディレクトリに設定します。
  9. インストールが正常に終了したかどうかをテストするには、次のコマンドを実行します。
    omce-test --version

カスタムAPI用のJavaScript Scaffoldのダウンロード

カスタムAPIを作成したら、APIのRAMLドキュメントに基づいたscaffoldをダウンロードし、そのscaffoldをクイック・スタートとして使用してカスタムAPIを実装できます。

Scaffoldは、ノード・モジュールの形式、各エンドポイント(リソースとHTTPメソッド)のスタブ・メソッドを含む主要なJavaScriptファイルおよびモジュールのマニフェストとして機能するpackage.jsonファイルであるキー・コンポーネントです。

Scaffoldをダウンロードする手順は、次のとおりです。

  1. これはサイドバー・メニューのイメージです。をクリックしてサイド・メニューを開き、「開発 」、「api」の順にクリックします。
  2. ダウンロードするAPIを開きます。
  3. APIデザイナの左のナビゲーション領域で、「実装」をクリックします。
  4. 「JavaScript Scaffold」をクリックして、zipファイルをダウンロードします。
  5. システム上で、ダウンロードしたファイルを解凍します。

後でAPIを変更した場合、更新済エンドポイントに基づいて新しいscaffoldをダウンロードできます。ただし、以前に行ってアップロードしたコーディングは、新しいscaffoldに反映されていません。

ファイル上のtoolsConfig.jsの構成

APIのRAMLドキュメントに基づいたscaffoldファイルをダウンロードした後、toolsConfig.jsonというJavaScript Notation (JSON)ファイルを手動で構成できます。

Oracle Mobile Hubでは、カスタムAPIのデプロイメント情報を含むtoolsConfig.jsonファイルが使用されます。デフォルトのtoolsConfig.jsonは、カスタムAPIの作成時に生成され、スキャフォールをダウンロードします。toolsConfig.jsonファイルを構成するには:

  1. Oracle Mobile Hubでモバイル・バックエンドの「設定」ページを開きます。
  2. 設定ページの情報をメモします。
    「設定」ページには、認証のタイプ(HTTP Basic、OAuth Consumer)や環境URLなどの情報が含まれます。
  3. テキスト・エディタを使用して、Oracle Mobile Hub「設定」ページの値でtoolsConfig.jsonファイルを更新します。
        "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. 開発」ページを開きます。
  5. インスタンスの詳細」をクリックします。
  6. チーム・メンバー・アプリケーション・クライアントIdおよびチーム・メンバー・アプリケーション・クライアント・シークレットの値をメモます。
  7. 次の値を使用してtoolsConfig.jsonファイルを更新します。
        "tools":{
            ...,
            "authorization":{
                "clientId":"<TEAM_MEMBER_APP_CLIENT_ID>",
                "clientSecret":"<TEAM_MEMBER_APP_CLIENT_SECRET>"
            }
        },
  8. (オプション) toolsConfig.jsonが正しいことをテストするには、デプロイメント・テストを実行します。ターミナル・ウィンドウを開き、omce-toolsディレクトリに移動し、次のコマンドを使用してカスタムAPIをデプロイします。
    node omce-deploy toolsConfig.json
    このコマンドの実行後、Oracle Mobile Hub資格証明の入力を求められます。toolsConfig.jsonファイルが正しい場合は、Deployment completed successfullyと記載されたメッセージが表示されます。このコマンドを使用して、将来カスタムAPIをデプロイできます。