REST API オプション
[サイドメニュー]
-[構成と監視]
-[REST API オプション]
の順でAWS API Gateway のAPIキーとバイナリメディアタイプの設定を表示します。
Tips
APIキー
APIキーはDebug/Releaseの実行環境で1つずつ保持しています。
REST APIの設定で [認証を必要とする]
を [必要]
にした場合、リクエストヘッダー名 [X-API-Key]
にAPIキーを指定することで、REST APIを呼び出すことができます。
コピー
表示されているAPIキーをコピーすることができます。
更新
表示されているAPIキーは、再生成することもできます。
[更新]
アイコンをクリックします。- 現時点のAPIキーが表示されているので、
[キーを再生成]
アイコンをクリックし、APIキーを再生成します [保存]
ボタンをクリックします。
Tips
バイナリメディアタイプ
REST APIでバイナリデータを扱う場合、サポートするバイナリメディアタイプを設定する必要があります。
下記の3つのタイプは事前に設定されています。
- image/*
- application/octet-stream
- multipart/form-data
設定手順
- バイナリメディアタイプ一覧の下部にある
[作成]
をクリックします。 - 登録ダイアログに設定するバイナリメディアタイプを入力します。
複数設定する場合は、[+]
ボタンをクリックすると、設定行を追加できます。 - 入力が終わったら、
[適用]
ボタンをクリックします。
バイナリメディアタイプ一覧
登録されているバイナリメディアタイプはリスト表示されます。
項目 | 説明 |
---|---|
バイナリメディアタイプ | 登録済みのバイナリメディアタイプ |
メニュー | 以下のメニューを表示します。
|