すべてのプロダクト
Search

このプロダクト

    API Gateway:REST APIの管理

    ドキュメントセンター

    API Gateway:REST APIの管理

    最終更新日:May 28, 2026

    Cloud-native API Gateway コンソールで REST API の公開、インポート、エクスポート、公開停止を行います。また、SDK とドキュメントをワンクリックで生成できます。

    APIの公開

    前提条件

    API を公開する前に、その API の操作が定義および作成されていることを確認してください。

    操作手順

    Cloud-native API Gateway は、共有 API とインスタンススコープ API の 2 種類の API をサポートしています。

    共有 API

    1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

    2. 対象の API の名前をクリックし、右上隅のPublishをクリックします。

    3. Publish API パネルで、パラメーターを設定し、Publish をクリックします。

      パラメーター

      説明

      [Domain Name]

      ドメイン名を選択します。公開後、このドメインを通じて API にアクセスできます。

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

      [Instance]

      ゲートウェイインスタンスを選択します。異なるインスタンスを使用して環境を分離します。

      [Scenario]

      シナリオには、基本とカナリアリリースが含まれます。バックエンドサービスのタイプについては、「ルーティング」をご参照ください。

      基本シナリオ

      • モック：操作のモック設定に基づいてモックレスポンスを返します。モック設定のない操作にはアクセスできません。

        説明

        モックシナリオで公開するには、少なくとも 1 つの操作でモック設定が有効になっている必要があります。そうでない場合、公開に失敗します。

      • [Single Service]：すべてのリクエストを単一のバックエンドサービスにルーティングします。最も一般的なユースケースです。

      カナリアリリースシナリオ

      • [By Percentage (Multi-service)]：パーセンテージに基づいてバックエンドサービスにトラフィックを分散します。トラフィックシフティングとカナリアリリースに使用されます。

        説明

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

      • By Content (Multi-service)は、一致条件に基づいて、トラフィックをさまざまなバックエンドサービスにルーティングします。Defaultとマークされたルールは、一致しないトラフィックを処理します。

        • サポートされる一致タイプ：等しい、プレフィックス、正規表現。

        • サポートされるパラメーターの場所：クエリパラメーター、リクエストヘッダー。

        複数の条件は AND ロジックを使用して組み合わされます。

        重要

        Defaultとして設定できるルールは 1 つだけです。それ以外のすべてのルールは、空でない一致条件を持つ必要があります。

      • [By Tag (Proportion-based Routing)]：複数のバックエンドサービスのバージョン間でパーセンテージに基づいてトラフィックを分散します。フルリンクカナリアリリースの場合は、単一サービスルーティングを推奨します。

      [Backend Services]

      ゲートウェイまたは VPC でバックエンドサービスを関連付けます。利用できるものがない場合は、Create Service をクリックして サービスを作成します。

      [Publish Description]

      この公開の説明を入力します。

    インスタンススコープ API

    1. クラウドネイティブ API ゲートウェイコンソールにログインします。 左側のナビゲーションペインで、インスタンス を選択します。 上部のナビゲーションバーで、リージョンを選択します。

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

    3. 右上隅のPublishをクリックします。Publish API パネルで、パラメーターを設定し、Publishをクリックします。

      パラメーター

      説明

      [インスタンス]

      API が公開されるインスタンスです。異なるインスタンスを使用して環境を分離します。

      [VPC]

      インスタンスが配置されている VPC です。

      [Publish Scope]

      公開する API 操作の範囲です。操作名をクリックすると詳細が表示されます。

      [Publish Description]

      この公開の説明を入力します。

    APIバージョンの追加

    重要

    現在、バージョンを追加できるのは共有 API のみです。

    1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択し、上部メニューでリージョンを選択します。

    2. 対象の API をクリックして、右上隅でMore > Add Versionを選択し、次のパラメーターを設定します。

      パラメーター

      説明

      [Usage]

      サポートされる方法：パス、クエリパラメーター、リクエストヘッダー。

      説明

      • Usageとして[クエリ]を選択した場合は、Add Queryパラメーターを設定する必要があります。

      • Usageとしてヘッダーを選択した場合は、Add Header パラメーターを設定する必要があります。

      • パス方式を使用する場合、完全なリクエストパスは次のようになります：/APIBasePath/VersionNumber/OperationPath。

      • Query メソッドを使用する場合、パス /APIBasePath/OperationPath を使用し、Add Query で指定されたクエリパラメーターにバージョン番号を含めてください。

      • ヘッダー メソッドを使用する場合、パス /APIBasePath/OperationPath を使用し、Add Header で指定されたリクエストヘッダーにバージョン番号を含めます。

    3. (任意) バージョンを追加した後、バージョンを切り替えるには、ページ上部のVersion タブをクリックします。

    公開履歴の表示

    説明

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

    1. 共有 API またはインスタンススコープ API の公開履歴を表示します。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 対象の API をクリックし、Publish Historyタブをクリックします。

      インスタンススコープ API

      1. クラウドネイティブ API ゲートウェイコンソールにログインします。 左側のナビゲーションペインで、インスタンス を選択します。 上部のナビゲーションバーで、リージョンを選択します。

      2. インスタンス ページで、ターゲットゲートウェイインスタンスの ID をクリックします。左側のナビゲーションペインで、API を選択し、ターゲット API をクリックして、Publish History タブをクリックします。

    2. 履歴バージョンの Actions 列で、View をクリックすると、その詳細が表示されます。

    SDKとドキュメントの生成

    1. 共有 API またはインスタンススコープ API の SDK とドキュメントを生成します。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 対象の API をクリックします。右上隅で、More > Generate SDK & Documentation を選択します。

      インスタンススコープ API

      1. Cloud-native API Gateway コンソールにログインします。 左側のナビゲーションペインで、インスタンス を選択します。 上部のナビゲーションバーで、リージョンを選択します。

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

      3. 右上隅で、More > Generate SDK & Documentation を選択します。

    2. More > Generate SDK & Documentation ダイアログボックスで、パラメーターを設定し、Generate and Download をクリックします。

      パラメーター

      説明

      [API Version]

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

      説明

      • インスタンススコープ API はバージョニングをサポートしていないため、このオプションは使用できません。

      • 共有 API の場合、このオプションは API 作成時にバージョン管理を有効にした場合にのみ使用できます。

      [Language]

      サポートされる SDK 言語：Java、Golang、Python、Node.js、TypeScript、Swift。

    3. 圧縮パッケージがブラウザのデフォルトのダウンロードフォルダに自動的にダウンロードされます。

      説明

      パッケージを解凍した後、SDK の使用方法についてはREADME.md ファイルをご参照ください。

    APIのインポート

    1. 共有 API またはインスタンススコープ API の API 定義をインポートします。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 目的の API をクリックします。右上隅で、More > Importを選択します。

      インスタンススコープ API

      1. クラウドネイティブ API ゲートウェイコンソールにログインします。左側のナビゲーションウィンドウで、インスタンス を選択します。上部のナビゲーションバーで、リージョンを選択します。

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

      3. 右上隅で、More > Import を選択します。

    2. Create File based on OpenAPI パネルで、パラメーターを設定し、Precheck and Create をクリックします。

    APIのエクスポート

    1. 共有 API またはインスタンススコープ API の API 定義をエクスポートします。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 対象の API をクリックし、右上隅で More > Import を選択します。

      インスタンススコープ API

      1. Cloud-native API Gateway コンソールにログインします。 左側のナビゲーションペインで、インスタンス を選択します。 トップナビゲーションバーで、リージョンを選択します。

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

      3. 右上隅で、More > Import を選択します。

    2. Export ダイアログボックスで OK をクリックすると、API 定義がブラウザのデフォルトのダウンロードフォルダーにダウンロードされます。

    APIの公開停止

    重要

    API を公開停止すると、API の操作は関連付けられたドメイン名を通じてアクセスできなくなります。リクエストは処理されなくなりますが、設定と公開履歴は保持されます。慎重に実行してください。

    1. 共有 API またはインスタンススコープ API を公開停止します。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 対象の API をクリックします。右上隅で、More > Shutdownを選択します。

      インスタンススコープ API

      1. クラウドネイティブ API ゲートウェイコンソールにログインします。左側のナビゲーションペインで、インスタンス を選択します。上部のナビゲーションバーで、リージョンを選択します。

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

      3. 右上隅で、More > Shutdown を選択します。

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

    APIの削除

    重要

    • 公開された API を削除する前に、すべてのインスタンスから公開停止する必要があります。

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

    1. 共有 API またはインスタンススコープ API を削除します。

      共有 API

      1. Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、[API] を選択します。上部メニューで、リージョンを選択します。

      2. 対象の API をクリックします。右上隅で、More > Delete を選択します。

      インスタンススコープ API

      1. クラウドネイティブ API ゲートウェイコンソールにログオンします。左側のナビゲーションペインで、インスタンスを選択します。上部のナビゲーションバーで、リージョンを選択します。

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

      3. 右上隅で、More > Delete を選択します。

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