Cloud Endpoints Portal の概要

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

ポータル

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

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

制限事項

  1. デベロッパー ポータルにアクセスするには、ユーザーが GCP プロジェクトで認証する必要があります。認証されていないユーザーは、デベロッパー ポータルを表示できません。
  2. [Try this API] パネルを使用するには、Endpoints サービスはアクセスできるように公開されている必要があります。Endpoints サービスで他の認証(IAP など)が構成されている場合、リクエストは失敗します。

次のステップ