API のデプロイとテスト

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

始める前に

API をデプロイする

App Engine の Apache Maven プラグインまたは Gradle プラグインを使用して、API をデプロイできます。本番用の App Engine スタンダード環境に API をデプロイするには、使用するプラグインに応じたコマンドを使用します。

  1. 使用するプラグインに応じて、次のいずれかのコマンドを使用します。

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. デプロイが完了するまで待ちます。

  3. デプロイした API にテスト リクエストを送信します。curl を使用した例を次に示します。

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    次のようなレスポンスが返されます。

    {
  "message": "echo echo"
}

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

複数のアプリケーション バージョンへのデプロイ

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

ローカルでの API バックエンドの実行とテスト

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

  1. プロジェクトのルート ディレクトリでプロジェクトをビルドします。次に例を示します。

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. App Engine 開発用サーバーを起動します。次に例を示します。

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. API リクエストを行って API をテストします。curl を使用した例を次に示します。

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

別のパスから API を提供する

別のパスから API を提供するには、web.xml ファイル内の EndpointsServlet セクションにある url-pattern を変更し、API を再デプロイします。次に例を示します。

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

API 管理の追加

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

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