API を試してみる

SmartDocs API リファレンス ドキュメントを閲覧するだけでなく、開発者は [この API を試す] パネルを使用できます。つまり、API ドキュメントを見ながらの API 操作が可能です。ポータルの中で、API にリクエストを送信して、そのレスポンスを見ることができます。API をポータルで試すことにより、API ユーザーは、その API を自分のコードで動作させるために何が必要かを理解できます。

API に API キーまたは認証が必要な場合は、ユーザーが API とやり取りできるようにポータルを構成しておく必要があります。ここでは、[この API を試す] を使用できるようにするために必要な要件と構成について説明します。 また、それぞれのタスクを実行するために最低限必要な Cloud Identity and Access Management の役割についても説明します。Cloud IAM の権限について詳しくは、以下をご覧ください。

前提条件

  • API バックエンドをデプロイしておく必要があります。
  • API に API キーが必要な場合は、API キーによる API アクセスの制限の説明に従って OpenAPI ドキュメントを構成する必要があります。
  • API に認証が必要な場合は、選択した認証方法で OpenAPI ドキュメントを構成する必要があります。認証方法の選択をご覧ください。
  • API は DNS 経由でアクセスできるようになっていなければなりません。

    • App Engine フレキシブル環境に API をデプロイすると、YOUR_PROJECT_ID.appspot.com 形式の名前の DNS エントリが自動的に作成されます。前述の例の YOUR_PROJECT_ID は、API のデプロイ先の GCP プロジェクトの ID です。つまり、追加構成なしでポータルで API をテストできます。
    • その他のバックエンド(Compute Engine や GKE など)については、API がカスタム ドメイン名(例: myapi.mycompany.com)を使用するように構成されていない場合は、cloud.goog ドメインを使用するように API を構成する必要があります。

API Explorer 設定を構成する

API に API キーや Firebase 認証または Auth0 認証が必要な場合、ユーザーが API を試用するには次の設定を構成する必要があります。このセクションでは、API キーと認証設定の構成方法について説明します。

API キーを構成する

ポータルで API キーを構成するには:

  1. Google Cloud Platform Console で、[API とサービス] > [認証情報] に移動します。

    [認証情報] ページに移動

  2. GCP Console ウィンドウ上部にある [プロジェクト] プルダウン リストで、API を作成した GCP プロジェクトを選択します。

    • 既存の API キーを使用する場合:

      1. 使用する API キーの横にある [API キーを編集] edit をクリックします。
      2. API キーの右にある [コピー] content_copy をクリックして、API キーをクリップボードにコピーします。
      3. [キャンセル] をクリックします。
    • API キーを作成する必要がある場合:

      1. [認証情報を作成] をクリックして [API キー] を選択します。
      2. キーをクリップボードにコピーします。
      3. [閉じる] をクリックします。
  3. ポータルに戻ります。

  4. [設定] settings をクリックします。

  5. [API] タブをクリックし、プルダウン リストから API を選択します。

  6. [APIs Explorer Settings] セクションで、API キーを [Google API key] フィールドに貼り付けます。

  7. [保存] をクリックします。

Firebase の構成

Firebase を構成するには:

  1. Firebase コンソールを開きます。

    • 既存の Firebase プロジェクトがない場合:

      1. [プロジェクトを追加] をクリックし、API が含まれている GCP プロジェクト名を選択します。
      2. [Authentication] カードで [始める] をクリックします。
      3. [ログイン方法] タブをクリックします。
      4. [ログイン プロバイダ] セクションで、使用するプロバイダを有効にします。
      5. [承認済みドメイン] セクションで [ドメインの追加] をクリックして、ポータル ドメイン名を追加します(endpointsportal.example-api.example.com など)。
      6. [ウェブ設定] をクリックします。カスタマイズされたコード スニペットが表示されます。次の手順でコード スニペットの情報が必要となるため、Firebase コンソールは開いたままにしておきます。
    • 既存の Firebase プロジェクトがある場合:

      1. [開発] > [Authentication] に移動します。
      2. [ログイン方法] タブをクリックします。
      3. [承認済みドメイン] セクションで [ドメインの追加] をクリックして、ポータル ドメイン名を追加します(endpointsportal.example-api.example.com など)。
      4. [ウェブ設定] をクリックします。カスタマイズされたコード スニペットが表示されます。次の手順でコード スニペットの情報が必要となるため、Firebase コンソールは開いたままにしておきます。
  2. ブラウザで別のタブを開き、ポータルに移動します。

  3. [設定] settings をクリックします。

  4. [Settings] ページで [API] タブをクリックし、プルダウン リストから API を選択します。

  5. [APIs Explorer Settings] セクションで、次の操作を行います。

    1. Firebase コード スニペットから apiKey フィールドの値をコピーし、[Google API key] フィールドにそれを貼り付けます。
    2. Firebase コード スニペットから authDomain フィールドの値をコピーし、[Firebase auth domain] フィールドにそれを貼り付けます。
  6. [保存] をクリックします。

詳細については、Firebase のドキュメントをご覧ください。

Auth0 の構成

タスクの概要を示す次のリストに従って、Auth0 とポータルを構成します。

タスク 1. Cloud Endpoints サービス用の Auth0 API があることを確認します。

タスク 2. Auth0 アプリケーション設定を構成します。

タスク 3. ポータルで Auth0 設定を構成します。

タスク 1: Endpoints サービス用の Auth0 API があることを確認する

  1. Auth0 ダッシュボードにログインします。
  2. 左側のナビゲーション バーで [API] をクリックします。[API Audience] の形式が https://SERVICE_NAMESERVICE_NAME は自分の Endpoints サービスの名前)である場合、API がすでに作成済みです。次のタスクに進んで、Auth0 アプリケーション設定を構成してください。

    それ以外の場合は、次の手順に従って API を作成します。

    1. [+ Create API] をクリックします。
    2. 名前を入力します。
    3. [Identifier] フィールドに、https://SERVICE_NAME の形式で URL を入力します。

      SERVICE_NAME は、Endpoints サービスの名前に置き換えます。サービス名がわからない場合は、サービス名と構成 ID の取得を参照して Endpoints サービスの名前を確認してください。

    4. [Create] をクリックします。

タスク 2: Auth0 アプリケーション設定を構成する

  1. Auth0 ダッシュボードで、左側のナビゲーション バーにある [Applications] をクリックします。
  2. 既存の Auth0 アプリケーションを選択するか、[+ Create Application] をクリックして新規に作成します。
  3. アプリケーションの [Settings] タブを開いて下にスクロールし、次に示すフィールドにポータル URL(例: https://endpointsportal.example-api.example.com)を追加します。

    • Allowed Callback URLs
    • Allowed Web Origins

    これらのフィールドには、複数の URL をカンマ区切りで指定できます。入力した URL の末尾に / 文字を含めないでください。

    1. [変更を保存] をクリックします。

    Auth0 の [Settings] ブラウザタブは開いたままにしておきます。次の手順でこのタブの情報が必要となります。

タスク 3: ポータルで Auth0 設定を構成する

  1. ブラウザで別のタブを開き、ポータルに移動します。
  2. [設定] settings をクリックします。
  3. [Settings] ページで [API] タブをクリックし、プルダウン リストから API を選択します。
  4. [APIs Explorer Settings] セクションで、次の操作を行います。

    1. Auth0 ダッシュボードの [Client ID] 項目の値をコピーし、[Auth0 client ID] 項目に貼り付けます。
    2. Auth0 ダッシュボードの [Domain] 項目の値をコピーし、[Auth0 domain] 項目に貼り付けます。
  5. [保存] をクリックします。

Auth0 を構成する方法については、Auth0 ドキュメントの Auth0 ダッシュボードの概要をご覧ください。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

OpenAPI を使用した Cloud Endpoints
ご不明な点がありましたら、Google のサポートページをご覧ください。