ローカル環境でAPIを起動する#

OVHcloud Data Platform は、開発と本番の両方でデプロイされたAPIをホストするための優れたツールですが、コードを編集する自然な場所ではありません。ほとんどのソフトウェアエンジニアは、自分のコンピュータ上でコードを編集することを好みます。

以下に、ローカル開発環境からAPIを構築してデプロイする方法を説明します。

• 0) 要件
• 1) ダウンロードしてローカルにインストール
• 2) APIを起動する
• 3) 認証を管理する
• 4) 全てを一緒に起動する

#要件

#NodeJS

現在、本番環境ではv10を使用していますが、すぐに14に更新する予定です。 ローカルでは両方のバージョンで動作しますが、現在はv14を使用することをお勧めしますが、更新が本番環境で完了するまで使用する関数に注意してください。 こちらからインストールしてください。

#Redis（オプション）

デフォルトでは、APIは本番環境でRedisをキャッシュとして使用します。 開発環境では無効にすることができますが、ローカルのRedisを使用することもできます。

#Redisのインストール

ローカルで使用したい場合は、Dockerのインストールと使用をお勧めします。 その後、以下のようにすることができます。

# start a redis locally
docker run --name redis -d -p 6379:6379 redis
# stop it
docker stop redis
# restart it
docker start redis
# remove it (need to be stop before, or to add the flag -f in the command)
docker rm redis

#またはキャッシュを無効にする

• "forepaas.json"を開きます
• 以下の発生を置き換えます

"cache": {
    "module": "cache-redis"
},

を

"_cache": {
    "module": "cache-redis"
},

にします。

• キャッシュRedisのメインオキュレンスを削除します

    "cache-redis": {
      "version": "2.0.0"
    },

#ダウンロードしてローカルにインストール

• GUIからAPI概要に移動します https://eu.dataplatform.ovh.net/#/api/\{ProjectID\}/\{API_NAME\}
• コピーしたいタグを選択し、「そのバージョンをダウンロード」をクリックします
• ZIPファイルを好みのフォルダに展開します
• Node依存関係をインストールします（デフォルトではパッケージマネージャーのyarnを使用しています。本番環境と同じ条件を得るために同じものを使用することをお勧めします）

yarn

#APIを起動する

デフォルトでは、「run.sh」スクリプトが見つかり、クイックランのサンプルがここにあります

KONG_INTERNAL_URI=false \
FOREPAAS_APPLICATION_CREDENTIALS=./creds.json \
FOREPAAS_QB_RESOURCE_ID=http://qb-service:9000 \
REDIS_URI=redis://127.0.0.1 \
ENV=development \
yarn run start

• KONG_INTERNAL_URI: これはURL計算の本番モードを無効にします。将来的にその変数を削除する予定です
• FOREPAAS_APPLICATION_CREDENTIALS: ローカルのcreds.jsonファイルにリンクするために使用されます。以下で説明します
• FOREPAAS_QB_RESOURCE_ID: レガシーACLリソースを取得します
• REDIS_URI: ローカルのRedisを使用する場合、前のセクションで説明したように、ここでURLをオーバーライドする必要があります（正しい値がすでに設定されているはずです）
• ENV: ローカル開発用にdevelopmentに設定します
• yarn run start: これはAPIを起動します。ローカル環境でコードが更新されるとすぐにリロードするにはyarn run watchを使用します

APIを起動すると、正常に開始するはずですが、プラットフォームに認証されず、APIがProject APIを呼び出すことはできません。そのためには、認証を受ける必要があります。

#認証を管理する

デフォルトでは、OVHcloud Data Platformの本番環境で、APIは他のProjectコンポーネントに対して自己認証されています。しかし、ローカル開発環境にいる場合は、Identity Access Managerを通じて認証する必要があります。

最も良い方法は、ユーザー（またはサービスアカウント）のAPIとシークレットキーを生成することです。また、Projectサブドメインも必要です。

キーとProjectサブドメインを取得したら、APIのルートに「creds.json」というファイルを作成できます。このファイルはコミットしてはいけません（デフォルトで.gitignoreに設定されています）。

{
    "dataplant_url": "https://{DATAPLANT_SUBDOMAIN}.eu.dataplatform.ovh.net",
    "api_key": "610aa8766608131b00000095610aa87f6608131b00000097",
    "secret_key": "8559d0f805dbb981XXXXXXXXXXXXXXXXXXXXXXXXXXXXX8bf9af358a4"
}

#全てを一緒に起動する

「run.sh」ファイルを呼び出してAPIを起動します。

sh run.sh

#さらに詳しく

当社のソリューションを実装するためのトレーニングや技術的なアシスタンスが必要な場合は、営業担当者にお問い合わせください、またはこのリンクをクリックして、当社のプロフェッショナルサービスの専門家にカスタム分析を依頼し、見積もりを受け取ってください。

質問をする、フィードバックを送信する、およびData Platformを構築するチームと直接交流するには、専用のDiscordチャネルにアクセスしてください。

OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。

ユーザーコミュニティに参加してください。