メソッドの変更

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

ユーザー定義したメソッドの設定を変更します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト構文

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

{
  "methodDescription" : "methodDescription",
  "httpEndPoint" : {
    "method" : "ANY",
    "stream" : true,
    "url" : "url"
  },
  "mockEndPoint" : {
    "headers" : {
      "key" : "value"
    },
    "response" : "response",
    "httpStatus" : 0
  },
  "ncpEndPoint" : {
    "method" : "ANY",
    "stream" : true,
    "service" : "service",
    "actionId" : "actionId",
    "region" : "KR",
    "url" : "url",
    "actionName" : "actionName"
  },
  "requiredApiKey" : {
    "required" : true
  },
  "validation" : {
    "headers" : [ "headers" ],
    "queryStrings" : [ "queryStrings" ],
    "type" : "NONE"
  },
  "authentication" : {
    "authorizerId" : "authorizerId",
    "platform" : "NONE"
  }
}

リクエストボディ

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

リクエスト例

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

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/p1hiuvmwv3/methods/OPTIONS' \
--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 '{
  "mockEndPoint": {
    "httpStatus": 400,
    "response": "user error"
  },
    "authentication": {
    "platform": "NONE"
  },
  "requiredApiKey": {
    "required": true
  },
  "validation": {
    "type": "NONE"
  }
}'

レスポンス

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

レスポンス構文

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

{
  "method" : {
    "methodDescription" : "methodDescription",
    "resourceId" : "resourceId",
    "useBodyWhenFormData" : true,
    "modifier" : "modifier",
    "resourcePath" : "resourcePath",
    "methodName" : "ANY",
    "ncpEndPoint" : {
      "method" : "ANY",
      "stream" : true,
      "service" : "service",
      "actionId" : "actionId",
      "region" : "KR",
      "url" : "url",
      "actionName" : "actionName"
    },
    "requiredApiKey" : {
      "required" : true
    },
    "mockEndPoint" : {
      "headers" : {
        "key" : "headers"
      },
      "response" : "response",
      "httpStatus" : 0
    },
    "produces" : "produces",
    "tenantId" : "tenantId",
    "consumers" : "consumers",
    "apiId" : "apiId",
    "validation" : {
      "headers" : [ "headers" ],
      "queryStrings" : [ "queryStrings" ],
      "type" : "NONE"
    },
    "authentication" : {
      "authorizerId" : "authorizerId",
      "platform" : "NONE"
    },
    "httpEndPoint" : {
      "method" : "ANY",
      "stream" : true,
      "url" : "url"
    }
  }
}

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

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

レスポンス例

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

{
  "method": {
    "apiId": "cvcohvd2xj",
    "resourceId": "p1hiuvmwv3",
    "methodName": "GET",
    "useBodyWhenFormData": false,
    "validation": {
      "type": "NONE"
    },
    "authentication": {
      "platform": "NONE"
    },
    "requiredApiKey": {
      "required": true
    },
    "mockEndPoint": {
      "httpStatus": 400,
      "response": "user error"
    },
    "tenantId": "********65ec41039ce6668c2058b8a9",
    "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
  }
}