API のデプロイとテスト

このページでは、API をデプロイする方法について説明します。

始める前に

API を本番環境にデプロイする

API をデプロイするには:

  1. ENDPOINTS_GAE_SDK 環境変数を App Engine SDK フォルダのパス Path_to_Cloud_SDK/platform/google_appengine に設定します。

    Path_to_Cloud_SDK は、次のコマンドの出力に置き換えます。

     gcloud info --format="value(installation.sdk_root)"

  2. API メイン ディレクトリで次のコマンドを呼び出します。

     gcloud app deploy

    デプロイが成功するまで数分待ちます。警告メッセージは無視します。デプロイが完了すると、次のようなメッセージが表示されます。

    File upload done.
Updating service [default]...done.

  3. API にテスト リクエストを送信して、デプロイが成功していることを確認します。以下に例を示します。

    curl --request POST \
   --header "Content-Type: application/json" \
   --data '{"content":"echo"}' \
   https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2

    PROJECT_ID はプロジェクト ID で置き換え、echo は API 名で置き換えます。

    結果は次のようになります。

    {
 "content": "echo echo"
}

正常なレスポンスが返されなかった場合は、レスポンス エラーのトラブルシューティングをご覧ください。

アプリの複数バージョンへデプロイする

API バージョニングの方法や複数のバージョンへのデプロイ方法については、API のバージョニングの処理をご覧ください。

ローカルで API をテストする

App Engine のローカルの開発用サーバーを使用して、ローカルで API をテストできます。ローカル開発サーバーの詳細については、ローカル開発用サーバーの使用をご覧ください。

API をローカルで実行するには以下の手順を行います。

  1. プロジェクトのルート ディレクトリから App Engine 開発用サーバーを開始します。

    dev_appserver.py YOUR_PROJECT_DIR

  2. curl を実行して API リクエストを送信します。例:

     curl --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

API 管理の追加

Endpoints Frameworks は、次の API 管理機能を提供します。

API が Endpoints Frameworks で管理されるようにするには、API を記述する OpenAPI ドキュメントを生成してデプロイする必要があります。詳細については、API 管理の追加をご覧ください。