Oracle Cloud Infrastructureドキュメント

APIゲートウェイ・クイックスタート・ガイド

API Gatewayを迅速に開始する方法をご紹介します。

A. テナンシを設定します

1グループとユーザーの作成

APIゲートウェイおよびネットワーク・リソースを作成およびアクセスするための適切なユーザーおよびグループがまだ存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」を選択します。「アイデンティティ」で、「ドメイン」を選択します。

  3. ドメインを選択し、「ユーザー管理」タブで、「グループ」セクションの「グループの作成」を選択して新しいグループを作成します。

  4. 「ユーザー管理」タブで、「ユーザー」セクションの「作成」を選択して新しいユーザーを作成します。

  5. 「ユーザー管理」タブで、「グループ」セクションでグループの名前を選択し、「ユーザー」タブを選択して、「グループへのユーザーの割当て」を選択して、ユーザーをグループに追加します。

詳細は、詳細な手順を参照してください。

2. コンパートメントの作成

APIゲートウェイ・リソースおよびネットワーク・リソースを作成する適切なコンパートメントがまだ存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティおよびセキュリティ」を選択します。「アイデンティティ」で、「コンパートメント」を選択します。

  3. 「コンパートメントの作成」を選択します。

詳細は、詳細な手順を参照してください。

3VCNとサブネットを作成します

高可用性を確保するために、AD固有のサブネットではなくリージョナル・サブネットでのみAPIゲートウェイを作成できます。ネットワークリソースを作成するパブリック・リージョナル・サブネットを持つ適切なVCNがまだ存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「ネットワーキング」、「仮想クラウド・ネットワーク」の順に選択します。
  3. 「アクション」メニューから「VCNウィザードの起動」を選択して、新しいVCNを作成します。

  4. 「VCNウィザードの起動」ダイアログ・ボックスで、「インターネット接続性を持つVCNの作成」を選択し、「VCNウィザードの起動」を選択します。

    VCNと同様に、ワークフローでは、インターネット・ゲートウェイ、NATゲートウェイおよびサービス・ゲートウェイとともに、パブリックのリージョン・サブネットとプライベートのリージョン・サブネットが作成されます。

  5. 新しいVCNの名前を入力し、VCNのCIDRブロック、パブリック・リージョナル・サブネット(32以上の空きIPアドレスを指定する必要があります)、およびプライベート・リージョナル・サブネットを指定します。

    この図は、インターネット接続性のあるVCNの作成ワークフローの「構成」ページを示しています。「VCN CIDRブロック」、「パブリック・サブネットCIDRブロック」および「プライベート・サブネットCIDRブロック」フィールドには、デフォルト値(それぞれ10.0.0.0/16、10.0.0.0/24および10.0.1.0/24)が含まれています。

  6. 「次へ」を選択して新しいVCNに入力した詳細を確認し、「作成」を選択して作成します。VCNが作成されたら、「VCNの表示」を選択して、新しいVCNおよび作成されたサブネットを表示します。

    APIゲートウェイは、デフォルトで開いていないポート443で通信します。ポート443でトラフィックを許可するには、パブリック・リージョン・サブネットに対して新しいステートフル・イングレス・ルールを追加する必要があります。

  7. 仮想クラウド・ネットワークの詳細ページで、「サブネット」タブを選択します。パブリック・リージョナル・サブネットの名前を選択し、「セキュリティ」タブを選択します。デフォルト・セキュリティ・リストの名前を選択し、「セキュリティ・ルール」タブを選択して、「イングレス・ルールの追加」を選択します。次を指定します:
    • ソース・タイプ: CIDR
    • ソースCIDR: 0.0.0.0/0
    • IPプロトコル: TCP
    • ソース・ポート範囲: すべて
    • 宛先ポート範囲: 443
  8. 新しいルールをデフォルトのセキュリティ・リストに追加するには、「イングレス・ルールの追加」を選択します。

詳細は、詳細な手順を参照してください。

4IAMポリシーの作成

1つ以上のAPI開発者がテナンシ管理者ではない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティおよびセキュリティ」を選択します。「アイデンティティ」にある「ポリシー」を選択します。

  3. API開発者にアクセス権を付与するポリシーを作成します:

    1. API開発者がAPIゲートウェイ関連リソースにアクセスできるようにする、1つのポリシー・ステートメントでポリシーを作成します。「ポリシーの作成」を選択し、新しいポリシーの名前と説明を指定し、APIゲートウェイ関連リソースを所有するコンパートメントを選択します。ポリシー・ビルダーのマニュアル・エディタを使用して、次のポリシー・ステートメントを入力し、「作成」を選択します。
      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>
    2. API開発者がネットワーク・リソースにアクセスできるようにするポリシーを1つのポリシー・ステートメントで作成します。「ポリシーの作成」を選択し、新しいポリシーの名前と説明を指定し、APIゲートウェイで使用するネットワーク・リソースを所有するコンパートメントを選択します。ポリシー・ビルダーのマニュアル・エディタを使用して、次のポリシー・ステートメントを入力し、「作成」を選択します。
      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

    ノート:前述のポリシーは、このクイックスタート・ガイドで提案されているように、HTTPバックエンドを使用してAPIデプロイメントを作成できるようにするのに十分です。追加のポリシー(ドキュメントを参照)を入力して、API開発者がOCI Functions関数をバックエンドとして使用してAPIデプロイメントを作成し、APIゲートウェイがキャッシュ・サーバーで認証してキャッシュされたレスポンス・データを取得できるようにすることができます。

詳細は、詳細な手順を参照してください。

B APIの作成、デプロイおよびコール

1最初のAPIゲートウェイの作成
  1. APIゲートウェイ開発者としてコンソールにサインインし、ナビゲーション・メニューを開き、「開発者サービス」を選択します。「API管理」で、「ゲートウェイ」を選択します。
  2. 「ゲートウェイの作成」を選択し、次を指定します:
    • 新しいゲートウェイの名前(acme-api-gatewayなど)
    • APIゲートウェイ・リソースを作成するコンパートメントの名前
    • Publicとしての新しいゲートウェイのタイプ
    • APIゲートウェイで使用するVCNの名前
    • VCN内のパブリック・リージョン・サブネットの名前
    このイメージは、「ゲートウェイの作成」ダイアログを示しており、デフォルトでは「タイプ」フィールドが「パブリック」に設定されていることを除き、すべてのフィールドが空になっています。
  3. 「作成」を選択します。

    新しいAPIゲートウェイが作成されると、「ゲートウェイ」ページのリストに「アクティブ」と表示されます。

詳細は、詳細な手順を参照してください。

2最初のAPIデプロイメントの作成
  1. コンソールの「ゲートウェイ」リスト・ページで、前に作成したAPIゲートウェイの名前を選択します。
  2. 「デプロイメント」タブで、「デプロイメントの作成」を選択します。

  3. 「基本情報」ページで、次を指定します:

    • 新しいAPIデプロイメントの名前(acme-API-deploymentなど)
    • APIデプロイメントに含まれる各ルートのパスに追加するパス接頭辞(/v1など)
    • 新規APIデプロイメントを作成するコンパートメント

  4. 「次へ」を選択して、「認証」ページを開きます。次に、「次へ」を選択して「ルート」ページを表示し、「ルートの追加」を選択して次を指定します:

    • パス(/helloなど)
    • バックエンド・サービスによって受け入れられるメソッド(GETなど)
    • バックエンド・サービスのタイプおよび関連する詳細。便宜上、単一のバックエンドを追加し、タイプにHTTPを指定し、バックエンドのURLとしてパブリックAPIを入力します(https://api.weather.govなど)。

  5. 「作成」を選択してルートを作成します。「次へ」を選択して新しいAPIデプロイメントに入力した詳細を確認し、「作成」を選択して作成します。

    新しいAPIデプロイメントが作成されると、APIデプロイメントのリストに「アクティブ」と表示されます。

  6. APIデプロイメントがアクティブな場合は、次のタスクに進みます。

詳細は、詳細な手順を参照してください。

3最初のAPIのコール

  1. APIゲートウェイの詳細ページの「デプロイメント」タブで、作成した新しいAPIデプロイメントを選択し、エンドポイントをコピーするために作成した新しいAPIデプロイメントのエンドポイントの横にある「コピー」を選択します。

  2. ターミナル・ウィンドウを開き、次のように入力してAPIをコールします。

    curl -k -X GET <deployment-endpoint>

    <deployment-endpoint>は、前のステップでコピーしたエンドポイントです。たとえば、https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/helloです。

完了しました。最初のAPIゲートウェイおよびAPIデプロイメントを作成し、APIゲートウェイ・サービスを使用して最初のAPIをコールしました。

詳細は、詳細な手順を参照してください。

4. ステップ

APIファンクションを作成、デプロイおよびコールしたので、次の方法について学習します:

これで完了です。