入門ガイド

API の構成とデプロイ

• Cloud Endpoints の構成

  Endpoints に OpenAPI ドキュメントをデプロイするための準備について説明します。

• Endpoints 構成をデプロイする

  Endpoints に OpenAPI ドキュメントをデプロイする方法について説明します。

• API バックエンドをデプロイする

  API のバックエンド コードと Extensible Service Proxy（ESP）をデプロイする方法について説明します。

• Kubernetes でのデプロイ

  Kubernetes で Endpoints を構成してデプロイする方法について説明します。

• ESP をローカルまたは別のプラットフォームで実行する

  ローカルマシンまたは別のクラウド プロバイダで ESP のインスタンスを構成する方法について説明します。

• 構成ファイルの比較

  Google Cloud Console の [Endpoints] > [サービス] ページにある [デプロイの履歴] タブと、デプロイされたサービス構成と以前のバージョンを比較する方法について説明します。

• サービス名と構成 ID の取得

  マネージド サービスの名前と構成 ID を取得する方法について説明します。

トラブルシューティングとモニタリング

• トラブルシューティングの概要

  一般的なトラブルシューティングについて説明します。また、詳細情報へのリンクも記載しています。

• Endpoints 構成のデプロイのトラブルシューティング

  Endpoints 構成をデプロイするときに発生する可能性があるエラーと、そのトラブルシューティング方法について説明します。

• レスポンス エラーのトラブルシューティング

  API へのリクエストからのレスポンスで発生したエラーをトラブルシューティングする方法について説明します。

• App Engine フレキシブル環境でのデプロイのトラブルシューティング

  App Engine フレキシブル環境にデプロイされた Endpoints のトラブルシューティング方法について説明します。

• Compute Engine でのデプロイのトラブルシューティング

  Compute Engine にデプロイされた Endpoints のトラブルシューティング方法について説明します。

• GKE デプロイのトラブルシューティング

  GKE にデプロイされた Endpoints のトラブルシューティング方法について説明します。

• JWT 検証のトラブルシューティング

  JWT 検証で不合格になり、クライアントへのレスポンスでエラーが返される場合のトラブルシューティング情報を説明します。

• API のモニタリング

  Endpoints によって自動的に維持されるログと指標を使用して、API の正常性をモニタリングする方法を説明します。

• API のトレース

  トレースのサンプリング レート、Cloud Trace のコストを見積もる方法、Google Cloud コンソールでトレースを表示する方法、トレースのサンプリングを無効化する方法について説明します。

Cloud Endpoints Portal

• Endpoints Portal の概要

  Endpoints Portal の概要を説明し、Endpoints Portal のデモ ウェブサイトへのリンクを示します。

• Endpoints Portal 使用のスタートガイド

  Endpoints Portal を作成する方法について説明し、Endpoints Portal ユーザー インターフェースを紹介します。

• SmartDocs の更新

  SmartDocs API リファレンス ドキュメントの概要、SmartDocs が OpenAPI ドキュメント内のフィールドを使用して API ドキュメントを生成する仕組み、SmartDocs を再生成する方法を説明します。

• API の試用

  ユーザーが API を試せるようにポータルを構成する方法を説明します。

• カスタム ドキュメントの追加

  サンプルのスタートガイドを変更する方法、および Endpoints Portal の追加ドキュメント ページを作成して表示する方法について説明します。

• API によるカスタム ドキュメントの同期

  API を使用してカスタム ドキュメントをポータルに同期させる方法を説明します。

• カスタム ドメインの設定

  カスタム ドメインを使用するための Endpoints Portal の設定方法について説明します。

DNS と SSL

• ドメイン名を確認する

  Endpoints API を提供するドメイン名の所有権を確認する方法を示します。

• 独自のドメイン名から API を提供する

  API リクエストに対応するために、プロジェクトを設定する方法について説明します。

• cloud.goog ドメインでの DNS の構成

  Google が所有および管理する cloud.goog ドメインを使用する Endpoints サービス用に DNS を構成する方法について説明します。

• ドメインから複数の API を提供する

  独自のドメインで独立した複数の API を実行する方法について説明します。

• ESP で SSL を有効にする

  ESP を使用して、デプロイされる Endpoints サービスの SSL ポートを有効にする方法について説明します。

• ESPv2 で SSL を有効にする

  ESPv2 を使用して、デプロイされる Endpoints サービスの SSL ポートを有効にする方法について説明します。

認証と API キー

• 認証方法の選択

  サポートされる各認証方法の概要とサンプルのユースケースについて説明します。

• API キーを使用する理由と条件

  API キーと認証に関する背景情報を提供します。

• ユーザーを認証するための Firebase の使用

  ESP が Firebase でユーザー認証を行い、クライアントから受信したリクエストを検証するように、OpenAPI ドキュメントを構成する方法について説明します。

• ユーザーを認証するための Auth0 の使用

  ESP が Auth0 でユーザー認証を行い、クライアントから受信したリクエストを検証するように、OpenAPI ドキュメントを構成する方法について説明します。

• ユーザーを認証するための Google ID トークンの使用

  ESP が Google ID トークンでユーザー認証を行い、クライアントから受信したリクエストを検証するように、OpenAPI ドキュメントを構成する方法について説明します。

• ユーザーを認証するためのカスタム メソッドの使用

  ESP がカスタム プロバイダでユーザー認証を行い、クライアントから受信したリクエストを検証するように、OpenAPI ドキュメントを構成する方法について説明します。

• サービス間の認証

  サービス間の呼び出しを認証する方法について説明します。

• API キーでのアクセスの制限

  許可されていないクライアント アプリケーションとサービスが、API へアクセスするのを防止する方法について説明します。

API アクセスの管理

• API アクセスの概要

  Endpoints で使用可能な API アクセス制御オプションについて説明します。

• API を有効にできるユーザーの制御

  独自の Google Cloud Platform プロジェクトで API を有効に設定できるユーザーを制御する方法について説明します。

• Google Cloud プロジェクトでの API の有効化

  Google Cloud プロジェクトで API を有効にする方法について説明します。

• API へのアクセス権の付与と取り消し

  他のチームメンバーが API の管理を行えるように、さまざまなレベルのアクセス権を付与する方法について説明します。

API ライフサイクル管理

• API ライフサイクル管理の概要

  Endpoints API のバージョニング機能について説明し、Endpoints API のバージョニングとステージングのベスト プラクティスを示します。

• API とインスタンスの削除

  不必要なコストを回避するため、API を削除し、API を動かしているインスタンスをシャットダウンする方法について説明します。

• マネージド サービスの復元

  誤って削除されたマネージド サービスを復元する方法を示します。

API リクエストの制限（ベータ版）

• 割り当てについて

  割り当ての主な機能の概要を説明します。

• 割り当ての構成

  API の割り当てを構成する方法について説明します。

• デフォルトの割り当て上限のオーバーライド

  特定のコンシューマ プロジェクトの割り当て上限を変更する方法について説明します。

ESP のカスタマイズ

• Google Kubernetes Engine でのカスタム nginx.conf の使用

  ESP を GKE にデプロイするためのカスタム nginx.conf ファイルの作成方法について説明します。

• CORS をサポートするカスタム nginx.conf の作成

  ESP で CORS サポートをカスタマイズする必要がある場合に備えて、開始点として nginx.conf に ESP CORS オプションを書き込む方法の例を示します。

その他の Endpoints 入門ガイド

• ESPv2 への移行

• App Engine スタンダード環境用 Cloud Endpoints Frameworks 入門ガイド

• Cloud Endpoints for gRPC 入門ガイド