Cloud Endpoints for OpenAPI

Cloud Endpoints は、Google が独自の API に使用しているのと同じインフラストラクチャを使用して、API の保護、モニタリング、分析、割り当て量の設定を行えるようにする API 管理システムです。Endpoints は、Extensible Service Proxy(ESP)および Extensible Service Proxy V2 ベータ版(ESPv2 ベータ版)と連携して、API 管理を行います。Endpoints、ESP、ESPv2 のベータ版の詳細については、Endpoints についてをご覧ください。

Endpoints は、REST API を定義するための業界標準である OpenAPI 仕様(以前の Swagger 仕様)のバージョン 2 をサポートしています。OpenAPI 仕様についてよくご存じない方は、OpenAPI の概要をご覧ください。

このドキュメント セットでは、OpenAPI で Endpoints を使用する方法について説明します。その他の Endpoints オプションのドキュメントについては、すべての Endpoints ドキュメントをご覧ください。

ドキュメントを次の順序でお読みになることをおすすめします。

  1. Endpoints の実際の動作を確認するには、Cloud Endpoints のクイックスタートを実行します。これは、スクリプトを使用してサンプル API を App Engine フレキシブル環境にデプロイします。

  2. 次に、API で使用するコンピューティング プラットフォームを決定する必要があります。この決定に役立つ情報については、以下のコンピューティング オプションの選択サポートされているコンピューティング プラットフォームをご覧ください。

  3. API のバックエンドを決定したら、選択したコンピューティング プラットフォームのチュートリアルに進んでください。

サポートされているコンピューティング プラットフォーム

Endpoints for OpenAPI では、ESP または ESPv2 ベータ版を使用して API を管理します。ESP と ESPv2 のベータ版はどちらもオープンソース プロジェクトであり、次の方法で利用できます。

  • Google Container Registry のコンテナ。
  • GitHub のソースコード。
    • ESP の構築について詳しくは、ESP README をご覧ください。
    • ESP の構築について詳しくは、ESP README をご覧ください。

ESP コンテナは、次の場所で実行できます。

ESPv2 ベータ版コンテナは次のように実行できます。

  • App Engine
  • Cloud Functions
  • Cloud Run
  • Cloud Run for Anthos
  • GKE
  • Compute Engine
  • Kubernetes

これらの機能は現在ベータ版です。詳細については、Cloud Endpoints についてをご覧ください。

App Engine フレキシブル環境では、app.yaml ファイルに行数を追加すると自動的に ESP がデプロイされます。詳細については、API と ESP のデプロイをご覧ください。ESPv2 ベータ版では App Engine フレキシブル環境がサポートされません。

第 1 世代の App Engine スタンダード環境では、Endpoints Frameworks を使用する必要があります。上記のいずれかのコンピューティング オプションにコンテナをデプロイする場合は、App Engine スタンダードのいずれかの世代のランタイムにプロキシするという方法があります。