Save method response body

Available in Classic and VPC

Add a response body to a customized method. The response status code must be added before you can save the body.

Request

The following describes the request format for the endpoint. The request format is as follows:

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

Request headers

For headers common to API Gateway, see API Gateway common headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`product-id`	String	Required	Product ID that the API belongs to 1 - 10 Check through View product list
`api-id`	String	Required	ID of the API whose response body you want to add 1 - 10 characters Check through View API
`resource-id`	String	Required	ID of the target resource in the API 1 - 10 characters Check through View resource list
`method-name`	String	Required	Target method type `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`
`status-code`	Integer	Required	Response status code Check through View method response

Request syntax

The request syntax is as follows.

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

Request body

The following describes the request body.

Field	Type	Required	Description
`modelId`	String	Required	ID of the model to apply Use a pre-created model Check available models through the View model action
`bodyName`	String	Required	Name of the response body to save 0 - 100 characters
`bodyDescription`	String	Optional	Response body description 0 - 300 characters

Request example

The following is a sample request.

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"
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

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

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.

Response example

The following is a sample response.

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