メイン コンテンツをスキップする 補完的コンテンツへスキップ

AWS API GatewayへのAPI定義のインポート

API定義をJSONファイルとしてAWS API Gatewayにインポートします。

始める前に

  • AWS APIゲートにアクセスできること。
  • AWS CLIをインストール済みであること。詳細は、[Installing the AWS CLI] (AWS CLIのインストール)を参照してください。
  • API定義をJSONファイルとしてエクスポート済みであること。

手順

  1. コマンドラインを開き、次のコマンドを入力してファイルをアップロードします:
    aws apigateway import-rest-api [--parameters endpointConfigurationTypes={type}] --body 'file://{yourfile}.json'
  2. 正しいパラメーターを追加します:
    パラメーター 説明
    {type} オプションです。使用するエンドポイントのタイプを定義します。値は次のようになります:
    • EDGE エッジ最適化APIのセットアップ用で、モバイルアプリケーションに最適(これがデフォルト値です)
    • REGIONAL リージョンAPIエンドポイント用
    • PRIVATE プライベートAPI用
    {yourfile} エクスポートしたAPI定義のパスとファイル名。
  3. コマンドを実行します。

タスクの結果

APIがインポートされ、そのAPIに関する情報(IDなど)がコマンドラインで返されます。この情報はアップデートに使用できます。AWS API Gatewayコンソールでの自分のAPI更新をチェックできます。

AWS API GatewayコンソールでのAPI定義。

import-rest-apiコマンドの詳細は、AWSドキュメンテーションを参照してください。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。