Save method request body
- Print
- PDF
Save method request body
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Add a request body to a customized method.
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}/request-body |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the API belongs to
|
api-id | String | Required | ID of the API whose request body you want to add
|
resource-id | String | Required | ID of the target resource in the API
|
method-name | String | Required | Target method type
|
Request syntax
The request syntax is as follows.
{
"bodyName" : "bodyName",
"modelId" : "modelId",
"bodyDescription" : "bodyDescription"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
bodyName | String | Required | Name of the request body to save
|
modelId | String | Required | ID of the model to apply
|
bodyDescription | String | Optional | Request body description
|
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/PATCH/request-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 '{
"bodyName" : "patchbody",
"modelId" : "qw33h0i33i",
"bodyDescription" : "api key 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": "patchbody",
"bodyDescription": "api key body"
}
Was this article helpful?