메서드 요청 바디 저장

Classic/VPC 환경에서 이용 가능합니다.

사용자 정의한 메서드에 요청 바디를 추가합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/request-body

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`product-id`	String	Required	API가 속한 Product ID 1~10자 Product 목록 조회를 통해 확인
`api-id`	String	Required	요청 바디를 추가할 API의 ID 1~10자 API 조회를 통해 확인
`resource-id`	String	Required	API 내 대상 리소스의 ID 1~10자 Resource 목록 조회를 통해 확인
`method-name`	String	Required	대상 메서드 타입 `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`

요청 구문

요청 구문은 다음과 같습니다.

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`bodyName`	String	Required	저장할 요청 바디의 이름 0~100자
`modelId`	String	Required	적용할 모델의 ID 미리 생성한 모델 사용 사용 가능한 모델은 모델 조회 액션을 통해 확인
`bodyDescription`	String	Optional	요청 바디에 대한 설명 0~300자

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://apigateway.apigw.gov-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"
}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

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

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "modelId": "qw33h0i33i",
    "modelName": "ApiKeyDto",
    "bodyName": "patchbody",
    "bodyDescription": "api key body"
}