메서드 수정
- 인쇄
- PDF
메서드 수정
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
사용자 정의한 메서드의 설정을 변경합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PATCH | /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name} |
요청 헤더
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 | 대상 메서드 타입
|
요청 구문
요청 구문은 다음과 같습니다.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
methodDescription | String | Optional | 메서드에 대한 설명
|
httpEndPoint | String | Conditional | HTTP(S) 엔드포인트의 호출 결과를 반환하는 엔드포인트 타입
|
httpEndPoint.method | String | Conditional | 백엔드 서버로 요청할 메서드 타입
|
httpEndPoint.stream | Boolean | Conditional | Stream 기능 사용 여부
|
httpEndPoint.url | String | Conditional | 백엔드 서버로 요청할 URL 경로
|
mockEndPoint | String | Conditional | API Gateway에서 설정한 값을 반환하는 엔드포인트 타입
|
mockEndPoint.httpStatus | Integer | Conditional | 응답 상태 코드
|
mockEndPoint.headers | Map<String, String> | Optional | 응답에 포함할 헤더
|
mockEndPoint.response | String | Optional | 응답에 표시할 데이터
|
ncpEndPoint | String | Conditional | 네이버 클라우드 플랫폼의 서비스를 이용해 값을 반환하는 엔드포인트 타입
|
ncpEndPoint.service | String | Conditional | 응답 반환에 사용할 네이버 클라우드 플랫폼의 서비스
|
ncpEndPoint.region | String | Conditional | Cloud Functions 서비스의 지원 리전 코드
|
ncpEndPoint.actionId | String | Conditional | Cloud Functions 서비스의 액션 ID
|
ncpEndPoint.actionName | String | Conditional | Cloud Functions 서비스의 액션 이름
|
ncpEndPoint.url | String | Conditional | Cloud Functions 서비스의 URL 경로
|
ncpEndPoint.method | String | Optional | Cloud Functions 서비스로 요청할 메서드 타입
|
ncpEndPoint.stream | Boolean | Conditional | Stream 기능 사용 여부
|
requiredApiKey | String | Required | API key 사용 정보 |
requiredApiKey.required | Boolean | Required | API key 사용 여부
|
validation | String | Required | 유효성 검사 정보 |
validation.type | String | Required | 유효성 검사 범위
|
validation.headers | List<String> | Conditional | 유효성 검사 대상인 필수 헤더 리스트
|
validation.queryStrings | List<String> | Conditional | 유효성 검사 대상인 필수 쿼리 스트링 리스트
|
authentication | String | Required | 인증 정보 |
authentication.platform | String | Required | 인증 방법 설정
|
authentication.authorizerId | String | Conditional | 인증 방법으로 Authorizer 이용 시 사용할 Authorizer의 ID |
요청 예시
요청 예시는 다음과 같습니다.
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
이 문서가 도움이 되었습니까?