AWS APIゲートウェイでのAPI定義の更新 - Cloud

Talend Cloud API Designerの例

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
ジョブデザインと開発 > Designing APIs
EnrichPlatform
Talend API Designer

既存の定義を更新できるよう、JSONファイルをAPIゲートウェイにインポートします。

始める前に

  • AWS APIゲートにアクセスできること。
  • AWS CLIをインストール済みであること。詳細は、[Installing the AWS CLI] (AWS CLIのインストール)を参照してください。
  • API定義をJSONファイルとしてエクスポート済みであること。
  • APIの以前のバージョンがAWS APIゲートウェイにアップグレードされていること。

手順

  1. コマンドラインを開き、次のコマンドを入力してファイルをアップロードします:
    aws apigateway put-rest-api --rest-api-id {api-id} --mode {mode} --body 'file://{yourfile}.json'
  2. 正しいパラメーターを追加します:
    パラメーター 説明
    {api-id} 更新するAPIのAWS APIゲートウェイID。
    [Mode] (モード) インポート時の動作。この値は、APIの以前のバージョンを新しいバージョンに上書きする場合はoverwriteに、2つのバージョンをマージする場合はmergeになります。
    {yourfile} エクスポートしたAPI定義のパスとファイル名。
  3. コマンドを実行します。

タスクの結果

定義したモードに応じて、API定義がマージまたは上書きされます。AWS APIゲートウェイコンソールの更新をチェックできます。

このサンプルでは、/contactsリソースの最初のバージョンとそのオペレーションだけを含んでいるAPI定義がアップロードされていました。次に、/companiesリソースを含んでいる2番目のバージョンがアップロードされ、以前のバージョンとマージされました。

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