API
- 인쇄
- PDF
API
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
API 복사
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/clone
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
{
"apiName" : "apiName",
"apiDescription" : "apiDescription",
"originApiId" : "originApiId"
}
응답 코드
- 201
응답 바디
{
"api" : {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
}
}
API 생성
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
{
"apiName" : "apiName",
"apiDescription" : "apiDescription"
}
응답 코드
- 201
응답 바디
{
"api" : {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
}
}
API 삭제
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
API 배포
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/deploy
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
{
"deploymentDescription" : "deploymentDescription",
"stageId" : "stageId"
}
응답 코드
- 200
응답 바디
- 없음
API 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| withStage | query string | N | Boolean | With Stage |
| apiName | query string | N | String | Api Name 길이(최대/최소): 0/20 |
| hasStage | query string | N | Boolean | Has Stage |
| hasStageNotAssociatedWithUsagePlanId | query string | N | String | Has Stage Not Associated With Usage Plan Id |
요청 바디
- 없음응답 코드
- 200
응답 바디
{
"total" : 0,
"apis" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
} ]
}
API 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/filter
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"total" : 0,
"apis" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
} ]
}
API 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"api" : {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
}
}
API 검색
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/infos
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| withStage | query string | N | Boolean | With Stage |
| apiName | query string | N | String | Api Name 길이(최대/최소): 0/20 |
| hasStage | query string | N | Boolean | Has Stage |
| hasStageNotAssociatedWithUsagePlanId | query string | N | String | Has Stage Not Associated With Usage Plan Id |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"total" : 0,
"apis" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
} ]
}
Swagger로부터 데이터 가져오기
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/import
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
{
"apiName" : "apiName",
"apiDescription" : "apiDescription",
"importValidateType" : "FAIL_ON_WARN",
"swagger" : "swagger"
}
응답 코드
- 200
응답 바디
{
"errorMessages" : [ "errorMessages" ],
"warnMessages" : [ "warnMessages" ],
"success" : true,
"api" : {
"apiName" : "apiName",
"domainCode" : "domainCode",
"productId" : "productId",
"modifier" : "modifier",
"permission" : "permission",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"stages" : [ {
"stageName" : "stageName",
"isPublished" : true,
"apiId" : "apiId",
"stageId" : "stageId"
} ],
"tenantId" : "tenantId",
"apiDescription" : "apiDescription",
"disabled" : true,
"apiId" : "apiId",
"actionName" : "actionName"
}
}
API 수정
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
{
"apiDescription" : "apiDescription"
}
응답 코드
- 204
응답 바디
- 없음
API 게시
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/publish
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
{
"stages" : [ {
"isPublished" : true,
"stageId" : "stageId"
} ]
}
응답 코드
- 204
응답 바디
- 없음
이 문서가 도움이 되었습니까?