Method
- 인쇄
- PDF
Method
- 인쇄
- 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
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| resourceId | path | Y | String | Resource Id 길이(최대/최소): 0/10 |
요청 바디
{
"methodDescription" : "methodDescription",
"mockEndPoint" : {
"headers" : {
"key" : "headers"
},
"response" : "response",
"httpStatus" : 0
},
"methodName" : "ANY",
"ncpEndPoint" : {
"method" : "ANY",
"stream" : true,
"service" : "service",
"actionId" : "actionId",
"region" : "KR",
"url" : "url",
"actionName" : "actionName"
},
"requiredApiKey" : {
"required" : true
},
"validation" : {
"headers" : [ "headers" ],
"queryStrings" : [ "queryStrings" ],
"type" : "NONE"
},
"httpEndPoint" : {
"method" : "ANY",
"stream" : true,
"url" : "url"
},
"authentication" : {
"authorizerId" : "authorizerId",
"platform" : "NONE"
}
}
응답 코드
- 201
응답 바디
{
"methods" : [ {
"methodDescription" : "methodDescription",
"resourceId" : "resourceId",
"useBodyWhenFormData" : true,
"modifier" : "modifier",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"ncpEndPoint" : {
"method" : "ANY",
"stream" : true,
"service" : "service",
"actionId" : "actionId",
"region" : "KR",
"url" : "url",
"actionName" : "actionName"
},
"requiredApiKey" : {
"required" : true
},
"mockEndPoint" : {
"headers" : {
"key" : "headers"
},
"response" : "response",
"httpStatus" : 0
},
"produces" : "produces",
"tenantId" : "tenantId",
"consumers" : "consumers",
"apiId" : "apiId",
"validation" : {
"headers" : [ "headers" ],
"queryStrings" : [ "queryStrings" ],
"type" : "NONE"
},
"authentication" : {
"authorizerId" : "authorizerId",
"platform" : "NONE"
},
"httpEndPoint" : {
"method" : "ANY",
"stream" : true,
"url" : "url"
}
} ]
}
메서드 삭제
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
메서드 consumers 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/consumers
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| 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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"consumers" : "consumers"
}
메서드 produces 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| 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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"produces" : "produces"
}
메서드 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| resourceId | path | Y | String | Resource Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"methods" : [ {
"methodDescription" : "methodDescription",
"resourceId" : "resourceId",
"useBodyWhenFormData" : true,
"endpointCode" : "endpointCode",
"modifier" : "modifier",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"ncpEndPoint" : {
"method" : "ANY",
"stream" : true,
"service" : "service",
"actionId" : "actionId",
"region" : "KR",
"url" : "url",
"actionName" : "actionName"
},
"requiredApiKey" : {
"required" : true
},
"mockEndPoint" : {
"headers" : {
"key" : "headers"
},
"response" : "response",
"httpStatus" : 0
},
"endpointActionId" : "endpointActionId",
"produces" : "produces",
"tenantId" : "tenantId",
"consumers" : "consumers",
"methodFilters" : [ {
"configJson" : "configJson",
"resourceId" : "resourceId",
"filterName" : "AUTH",
"apiId" : "apiId",
"methodCode" : "methodCode"
} ],
"apiId" : "apiId",
"validation" : {
"headers" : [ "headers" ],
"queryStrings" : [ "queryStrings" ],
"type" : "NONE"
},
"authentication" : {
"authorizerId" : "authorizerId",
"platform" : "NONE"
},
"endpointConfigJson" : "endpointConfigJson",
"httpEndPoint" : {
"method" : "ANY",
"stream" : true,
"url" : "url"
}
} ]
}
메서드 consumers 수정
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/consumers
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| 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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
{
"consumers" : "consumers"
}
응답 코드
- 200
응답 바디
{
"consumers" : "consumers"
}
메서드 produces 수정
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| 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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
{
"produces" : "produces"
}
응답 코드
- 200
응답 바디
{
"produces" : "produces"
}
메서드 수정
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-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 Name 허용 가능한 값: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
요청 바디
{
"methodDescription" : "methodDescription",
"mockEndPoint" : {
"headers" : {
"key" : "headers"
},
"response" : "response",
"httpStatus" : 0
},
"ncpEndPoint" : {
"method" : "ANY",
"stream" : true,
"service" : "service",
"actionId" : "actionId",
"region" : "KR",
"url" : "url",
"actionName" : "actionName"
},
"requiredApiKey" : {
"required" : true
},
"validation" : {
"headers" : [ "headers" ],
"queryStrings" : [ "queryStrings" ],
"type" : "NONE"
},
"httpEndPoint" : {
"method" : "ANY",
"stream" : true,
"url" : "url"
},
"authentication" : {
"authorizerId" : "authorizerId",
"platform" : "NONE"
}
}
응답 코드
- 200
응답 바디
{
"method" : {
"methodDescription" : "methodDescription",
"resourceId" : "resourceId",
"useBodyWhenFormData" : true,
"modifier" : "modifier",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"ncpEndPoint" : {
"method" : "ANY",
"stream" : true,
"service" : "service",
"actionId" : "actionId",
"region" : "KR",
"url" : "url",
"actionName" : "actionName"
},
"requiredApiKey" : {
"required" : true
},
"mockEndPoint" : {
"headers" : {
"key" : "headers"
},
"response" : "response",
"httpStatus" : 0
},
"produces" : "produces",
"tenantId" : "tenantId",
"consumers" : "consumers",
"apiId" : "apiId",
"validation" : {
"headers" : [ "headers" ],
"queryStrings" : [ "queryStrings" ],
"type" : "NONE"
},
"authentication" : {
"authorizerId" : "authorizerId",
"platform" : "NONE"
},
"httpEndPoint" : {
"method" : "ANY",
"stream" : true,
"url" : "url"
}
}
}
이 문서가 도움이 되었습니까?