Method Response Header
- 인쇄
- PDF
Method Response Header
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
메서드 응답 헤더 추가
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| resourceId | path | Y | String | Resource Id 길이(최대/최소): 0/10 |
| methodName | path | Y | String | Method Code 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
요청 바디
{
"parameterType" : "string",
"isArray" : true,
"parameterName" : "parameterName",
"parameterDescription" : "parameterDescription"
}
응답 코드
- 201
응답 바디
{
"methodParameterDto" : {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
}
}
메서드 응답 헤더 삭제
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters/{parameter-name}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| resourceId | path | Y | String | Resource Id 길이(최대/최소): 0/10 |
| methodName | path | Y | String | Method Code 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
| parameterName | path | Y | String | Parameter Name |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
메서드 응답 헤더 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| resourceId | path | Y | String | Resource Id 길이(최대/최소): 0/10 |
| methodName | path | Y | String | Method Code 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"headers" : [ {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
} ]
}
이 문서가 도움이 되었습니까?