Cloud Endpoints Portal の概要

Cloud Endpoints Portal を使用して、デベロッパー ポータルを作成します。デベロッパー ポータルとは、Cloud Endpoints API のユーザーが API を調べてテストするためにアクセスできるウェブサイトです。開発中のコードで API を使用するデベロッパーは、このポータルで SmartDocs API リファレンス ドキュメントを参照できます。SmartDocs では、OpenAPI ドキュメントを使用して API リファレンス ドキュメントを生成します。 SmartDocs には [Try this API] パネルが含まれているので、デベロッパーはドキュメントを表示したまま API を操作できます。

ポータル

独自のカスタム ドキュメントを提供して、ユーザーが API を問題なく使用できるようにすることもできます。

Endpoints Portal のデモで、さまざまな Endpoints サンプルから作成されたポータルをご覧ください。

制限事項

  1. デベロッパー ポータルにアクセスするには、ユーザーが GCP プロジェクトで認証する必要があります。認証されていないユーザーは、デベロッパー ポータルを表示できません。
  2. [Try this API] パネルを使用するには、Endpoints サービスはアクセスできるように公開されている必要があります。Endpoints サービスで他の認証(IAP など)が構成されている場合、リクエストは失敗します。
  3. Endpoints Portal では、1 つの Endpoints デプロイメントの異なる名前空間で宣言された同じ名前のメッセージやサービスはサポートされていません。これは、Endpoints で API のバージョニングのベスト プラクティスに従おうとするユーザーに影響する可能性があります。誤ったメッセージまたはサービスのバージョニングを回避するには、次のいずれかの方法を使用します。
    • すべての .proto ファイル内のメッセージとサービスに一意の名前を付ける。たとえば、バージョン 1 では data メッセージに data1、バージョン 2 では data2 と名前を付けます。
    • API バージョンを複数の Endpoints デプロイメントに分離する。

次のステップ