メソッドレスポンスボディの保存

Prev Next

Classic/VPC環境で利用できます。

ユーザー定義したメソッドにレスポンスボディを追加します。ボディを保存するには、レスポンスステータスコードが追加されている必要があります。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/response-body

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
product-id String Required APIが属する Product ID
api-id String Required レスポンスボディを追加する対象の API ID
resource-id String Required API内対象リソースの ID
method-name String Required 対象メソッドのタイプ
  • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD
status-code Integer Required レスポンスステータスコード

リクエスト構文

リクエスト構文は次の通りです。

{
  "modelId" : "modelId",
  "bodyName" : "bodyName",
  "bodyDescription" : "bodyDescription"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
modelId String Required 適用するモデルの ID
  • 予め作成済みのモデルを使用
  • 使用可能なモデルはモデルの照会を通じて確認
bodyName String Required 保存するレスポンスボディの名前
  • 0~100文字
bodyDescription String Optional レスポンスボディの説明
  • 0~300文字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/responses/400/response-body' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "modelId": "qw33h0i33i",
    "bodyName": "ApiKeyDto",
    "bodyDescription": "This is response body"
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
  "modelId" : "modelId",
  "modelName" : "modelName",
  "bodyName" : "bodyName",
  "bodyDescription" : "bodyDescription"
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "modelId": "qw33h0i33i",
    "modelName": "ApiKeyDto",
    "bodyName": "ApiKeyDto",
    "bodyDescription": "This is response body"
}