すべてのプロダクト
Search

このプロダクト

    API Gateway:REST API の管理

    ドキュメントセンター

    API Gateway:REST API の管理

    最終更新日:Nov 09, 2025

    このトピックでは、コンソールを介して REST API を管理する方法について説明します。これには、API の公開、インポート、エクスポート、非公開などの主要な操作が含まれます。また、コンソールでワンクリックで SDK とそのドキュメントを生成することもでき、API の効率的な管理と統合に役立ち、開発プロセスの利便性を向上させます。

    API の公開

    前提条件

    API を公開する前に、API で操作を定義して作成する必要があります。

    手順

    クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で API を公開します。

    インスタンス外の API

    1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

    2. 対象の API をクリックします。右上隅にある [公開] をクリックします。

    3. [API の公開] パネルで関連パラメーターを設定し、[公開] をクリックします。

      設定項目

      説明

      ドメイン名

      API を公開するドメイン名を選択します。公開された API は、ドメイン名を使用してアクセスできます。

      利用可能なドメイン名がない場合は、[ドメイン名の追加] をクリックします。詳細については、「ドメイン名の作成」をご参照ください。

      インスタンス

      作成したクラウドネイティブ API Gateway インスタンスを選択します。異なるビジネス環境は、異なるインスタンスによって区別され、複数の環境で API 公開を実装できます。

      シナリオ

      シナリオには、基本シナリオとグレースケールシナリオが含まれます。さまざまな種類のターゲットサービスの詳細については、「ルーティング」をご参照ください。

      基本シナリオ

      • Mock: 操作の応答は、操作定義の Mock 設定を返します。操作に Mock 設定が定義されていない場合、操作にアクセスできません。

        説明

        API を Mock シナリオに公開する場合は、API 内の少なくとも 1 つの操作に Mock 応答が設定されていることを確認する必要があります。そうしないと、API の公開に失敗します。

      • 単一サービス: すべてのトラフィックリクエストは、特定のバックエンドサービスに転送されます (最も一般的に使用されるシナリオ)。

      グレースケールシナリオ

      • 比率別 (複数サービス): すべてのトラフィックは、比率に応じて対応するバックエンドサービスに分散されます。これは、トラフィックの切り替えや段階的リリースのシナリオで一般的に使用されます。

        説明

        すべてのサービスの重みの合計は 100 になる必要があります。

      • コンテンツ別 (複数サービス): すべてのトラフィックは、一致条件に従って対応するバックエンドサービスに分散されます。一致条件で [デフォルト] オプションが選択されている場合、他の一致ルールにヒットしないと、トラフィックはそのエントリに対応するバックエンドサービスに入ります。

        • 次の一致条件タイプがサポートされています: 等しい、プレフィックス、正規表現。

        • サポートされているパラメータータイプ: クエリとヘッダー。

        複数の一致条件の間では、「and」操作ロジックが使用されます。

        重要

        [デフォルト] オプションを選択できるエントリは 1 つだけであり、残りのエントリの一致条件を空にすることはできません。

      • タグベースルーティング (比率別): タグベースルーティングシナリオでは、すべてのトラフィックは複数のバックエンドサービスの複数のバージョンに比例して分散されます。エンドツーエンドのグレースケールシナリオでは、パフォーマンスとエクスペリエンスを向上させるために、まず単一サービスルーティングを使用することをお勧めします。

      バックエンドサービス

      ゲートウェイ/VPC 配下のバックエンドサービスを関連付けます。ゲートウェイ配下にバックエンドサービスがない場合は、[サービスの作成] をクリックします。詳細については、「サービスの作成」をご参照ください。

      公開の説明

      公開された API の説明を入力します。

    インスタンス内の API

    1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

    2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

    3. 右上隅にある [公開] をクリックします。[API の公開] パネルで関連パラメーターを設定し、[公開] をクリックします。

      設定項目

      説明

      インスタンス

      作成したクラウドネイティブ API Gateway インスタンス。異なるビジネス環境は、異なるインスタンスによって区別され、複数の環境で API 公開を実装できます。

      VPC

      インスタンス操作が属する VPC。

      公開範囲

      API レベルの操作の公開範囲。操作名を選択して、影響を受ける操作の詳細を表示できます。

      公開の説明

      公開された API の説明を入力します。

    API バージョンの追加

    重要

    現在、インスタンス外で作成された API のみバージョン追加をサポートしています。

    1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

    2. 対象の API をクリックし、右上隅にある [その他の操作] > [バージョンの追加] をクリックします。関連する設定を完了します。

      設定項目

      説明

      使用方法

      3 つのメソッドをサポートしています: [パス]、[クエリ]、[ヘッダー]。

      説明

      • [使用方法] を [クエリ] として選択する場合、パラメーター [クエリの追加] を設定する必要があります。

      • [使用方法] を [ヘッダー] として選択する場合、パラメーター [ヘッダーの追加] を設定する必要があります。

      • [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス である必要があります。

      • [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス であり、リクエストパラメーターはパラメーター [クエリの追加] をバージョン番号として設定する必要があります。

      • [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス であり、リクエストヘッダーはパラメーター [ヘッダーの追加] をバージョン番号として設定する必要があります。

    3. (オプション) 追加後、ページ上部の [バージョン] をクリックしてバージョンを切り替えることができます。

    履歴バージョンの表示

    説明

    公開履歴には最新 10 件のレコードが保持されます。

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で履歴バージョンを表示します。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックし、[公開履歴] タブをクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックして、[公開履歴] タブをクリックします。

    2. 対象の履歴バージョンの [アクション] 列にある [表示] をクリックして、履歴バージョンの詳細を表示します。

    SDK とドキュメントの生成

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で SDK とドキュメントを生成します。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックします。右上隅にある [その他の操作] > [SDK とドキュメントの生成] をクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

      3. 右上隅にある [その他の操作] > [SDK とドキュメントの生成] をクリックします。

    2. [SDK とドキュメントの生成] ダイアログボックスで、関連パラメーターを設定し、[生成してダウンロード] をクリックします。

      設定項目

      説明

      API バージョン

      SDK とドキュメントを生成する API のバージョンを選択します。

      説明

      • インスタンス内で作成された API にはバージョン管理機能がないため、このオプションは利用できません。

      • インスタンス外で作成された API の場合、API バージョン管理機能を有効にするかどうかを選択できます。API の作成時にバージョン管理が有効になっていなかった場合、このオプションは利用できません。

      SDK 言語

      SDK を生成する言語を選択します。有効な値: Java、Golang、Python、Node.js、TypeScript、Swift。

    3. SDK とドキュメントが生成され、自動的にダウンロードされるまで待ちます。これらは圧縮パッケージとしてローカルコンピューターに自動的にダウンロードされます。その後、ブラウザのダウンロードパスに移動してパッケージを表示します。

      説明

      抽出後、SDK の使用ガイドとして README.md ドキュメントを参照できます。このドキュメントには、SDK を使用するために必要な基本情報が含まれています。

    API のインポート

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で API をインポートします。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックします。右上隅にある [その他の操作] > [インポート] をクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

      3. 右上隅にある [その他の操作] > [インポート] をクリックします。

    2. [OpenAPI に基づいてファイルを作成] パネルで、関連パラメーターを設定し、[ドライランして作成] をクリックします。

    API のエクスポート

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で API をエクスポートします。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックします。右上隅にある [その他の操作] > [エクスポート] をクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

      3. 右上隅にある [その他の操作] > [エクスポート] をクリックします。

    2. [エクスポート] ダイアログボックスで、[確認] をクリックします。ブラウザは API をローカルコンピューターのデフォルトのダウンロードパスにダウンロードします。

    API の非公開

    重要

    非公開後、関連するすべてのドメイン名は API 配下の操作にアクセスできなくなります。API インスタンスはリクエストの処理を停止しますが、その設定と履歴はシステムに保持されます。この操作は慎重に行ってください。

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で API を非公開にします。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックします。右上隅にある [その他の操作] > [非公開] をクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

      3. 右上隅にある [その他の操作] > [非公開] をクリックします。

    2. [非公開の確認] ダイアログボックスで、[非公開] をクリックします。

    API の削除

    重要

    • 現在の API に公開済みのインスタンスがある場合、削除操作の前にすべてのインスタンスを非公開にする必要があります。

    • API を削除すると、API の設定、ドキュメント、履歴が完全に削除され、回復できません。この操作は慎重に行ってください。

    1. クラウドネイティブ API Gateway は、インスタンス外とインスタンス内の 2 つの方法で API を削除します。

      インスタンス外の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [API] を選択し、トップメニューバーでリージョンを選択します。

      2. 対象の API をクリックします。右上隅にある [その他の操作] > [削除] をクリックします。

      インスタンス内の API

      1. クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、トップメニューバーでリージョンを選択します。

      2. [インスタンス] ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、対象の API をクリックします。

      3. 右上隅にある [その他の操作] > [削除] をクリックします。

    2. [削除の確認] ダイアログボックスで、[削除] をクリックします。