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の作成」オプションが選択された「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が作成されたら、「Virtual Cloud Networkの表示」を選択して、新しいVCNおよび作成されたサブネットを表示します。

    この図は、「インターネット接続性を持つVCNの作成」ワークフローの「レビューおよび作成」ページを示しており、すべてのリソースが作成済と示されています。「View Virtual Cloud Network」ボタンが表示されます。

    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>

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

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

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

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

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

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

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

  3. 「最初から」を選択し、「基本情報」セクションで次を指定します:

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

    この図は、「最初から」オプションが選択された「デプロイメントの作成」ワークフローの「基本情報」ページを示しています。デフォルトでは、その他のフィールドは空です。

  4. 「次」を選択し、「ルート1」セクションで次を指定します:

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

    この図は、「デプロイメントの作成」ワークフローの「ルート」ページを示しており、デフォルトではすべてのフィールドが空です。

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

    この図は、「デプロイメントの作成」ワークフローの「レビュー」ページを示しています。「基本情報」セクションの「名前」フィールドにはacme-api-deploymentが含まれ、「パス接頭辞」フィールドには/v1が含まれます。「ロギング・ポリシー」セクションの「実行ログ・レベル」フィールドには情報が含まれます。

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

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

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

3最初のAPIのコール

  1. 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ファンクションを作成、デプロイおよびコールしたので、次の方法について学習します:

これで完了です。