Stage を生成する
APIを生成するためにはまず Stageを生成する必要が’あります。
① My Products > APIs > Stage メニューから移動して Stageタブを選択します。
② Stage を生成をクリックします。
③ Stage 生成に必要な値を入力します。
- Stage 名 Stageの名前を入力します。Stageの名前はAPI Gatewayの呼び出しURLのルートに含まれます。
- Endpoint ドメイン: バックエンドサーバのドメインを入力します。APIのResource Pathと結合してバックエンドサーバに呼び出すルートになります。
- API キャッシュ: Cacheを設定します。
- TTL: Cacheを維持する秒(sec)を設定します。
- Throttling: 登録した Method別に秒当たりのリクエスト数を制限してバックエンドサーバを保護します。
- IP ACL: IPを通じてAPIリクエストを制御します。
- メンテナンス: 全ての APIが定義された状態コードとレスポンスをリターンするように設定します。
④ 生成をクリックします。
- Stageが生成される際に定義されているAPIが新たなStageに配布されます。
① API を配布をクリックします。
- APIは1つの Stageには何度も配布でき、配布履歴で管理されます。
① API 配布に必要は値を入力します。
- 配布する Stage: 配布する Stageを選択します。
- 説明:配布の説明を入力します。
② 追加をクリックします。
① Stages タブを選択します。
② 配布した APIを呼び出しできるURLです。
このURLは次のように構成されます。
https://{product-id}.apigw.ntruss.com/{api-name}/{stage-name}
③ 追加したResourceが Stageへ配布されます。
API を呼び出す
API 配布まで進んだら APIを呼び出すことができます。
API の呼び出しをご参照ください。
エクスポート
Stageに配布されたAPIは Swagger Jsonでダウンロードできます。
① Export タブを選択します。
② ダウンロードする形式を選択します。
③ エクスポートを選択すると選択したプラットフォームに合ったSDKをダウンロードできます。
配布履歴
StageではAPIを何度も配布できます。また、以前配布した設定に戻すこともできます。
① Deployment History タブを選択します。
② Stageに配布された Deploymentに表示されます。.
③ 以前配布されていた他のDeploymentを選択して配布することができます。