用語集
このページでは、API Gateway のドキュメントで使用されている用語の簡単な定義と詳細情報へのリンクをまとめています。
- API
- あるアプリケーションで別のアプリケーションの機能やデータを「使い」やすくするインターフェースです。持続性のあるシンプルで文書で十分に裏付けられたエントリ ポイントを定義することで、他のデベロッパーによって構築されたアプリケーション ロジックへのアクセスやそれらの再利用を簡単にします。
- API 構成
- API 定義を API Gateway にアップロードするときに作成されます。API 定義をアップロードするたびに、API Gateway によって新しい API 構成が作成されます。つまり、API 構成は作成できますが、後で変更することはできません。後で API 定義を編集してから、編集した API 定義をアップロードする場合は、新しい API 構成を作成します。
- API 定義
- API 構成の作成に使用される Open API 2.0 仕様または gRPC 構成。API 定義では、バックエンド サービスの URL、リクエストで渡されるデータのデータ形式、サービスによって返されるデータのデータ形式、サービスへのアクセスを制御するために使用される認証メカニズム、その他多くのオプションを指定します。
- API キー
- クライアント アプリケーションから API を呼び出すときに渡されるコードです。この API キーによって、API を呼び出したアプリケーションや Google Cloud プロジェクトが識別されます。API Gateway API で API キーを使用する方法の詳細については、API キーを使用する理由と条件をご覧ください。
- Auth0
- アプリケーションに対するユーザーの認証方法を定義するためのサービスです。詳細については、Auth0 をご覧ください。
- CORS
- クロスオリジン リソース シェアリング（CORS）とは、ウェブ アプリケーションが別のドメイン（技術的に言うと別のオリジン）にあるサーバー上のリソースにアクセスできるようにする仕様です。CORS の詳細については、Mozilla Developer Network（MDN）ウェブ ドキュメントと Fetch Living Standard をご覧ください。
- Firebase Authentication
- Google が提供する認証サービスであり、Google、Facebook、Twitter など一般的なフェデレーション ID プロバイダの認証情報を使用してクライアント アプリケーションにログインすることを可能にします。詳細については、Firebase Authentication をご覧ください。
- ゲートウェイ
- デプロイされた API 構成をホストする、Envoy ベースの高パフォーマンスでスケーラブルなプロキシ。ゲートウェイを作成すると、API クライアントが API へのアクセスに使用する外部向け URL が作成されます。ゲートウェイは単一の API 構成のみをホストします。複数の API 構成を同じゲートウェイにデプロイすることはできません。
- Google ID トークン
- Google のユーザー アカウントやサービス アカウントの識別に必要な OpenID Connect フィールドを含む JSON ウェブトークン（JWT）です。Google の認証サービス
https://accounts.google.comによって署名されます。 - gRPC
- Google が開発した高パフォーマンスのオープンソース ユニバーサル RPC フレームワークです。gRPC では、クライアント アプリケーションから別のマシンのサーバー アプリケーション上のメソッドを、ローカル オブジェクトであるかのように直接呼び出すことが可能です。API Gateway での gRPC の使用については gRPC の概要、一般的な情報については gRPC のウェブサイトをご覧ください。
- JWT
- JSON ウェブトークンは、HTTP Authorization ヘッダーおよび URI クエリ パラメータで使用するオープン標準のアクセス トークン形式です。一般情報については、JSON ウェブトークンの概要をご覧ください。
- OpenAPI
- Open API Initiative は、REST API 記述の標準化を推進する業界団体です。OpenAPI 仕様（旧称 Swagger 仕様）で記述された API は、ドキュメントの作成、テストの自動化、クライアントとサーバー用のコード生成を行う一般的なツールでサポートされます。詳細については、OpenAPI の概要をご覧ください。
- OpenAPI ドキュメント
- API を記述するために使用する YAML 形式または JSON 形式のファイル。このファイルは API 定義とも呼ばれます。API Gateway にアップロードされると、OpenAPI ドキュメントが API 構成に変換されます。
- サーフェス
- API のパブリック インターフェースです。API の surface はメソッドに加えて、メソッドで使用されるパラメータと戻り値の型で構成されています。