Product 문서 조회
    • PDF

    Product 문서 조회

    • PDF

    기사 요약

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

    사용자가 지정한 조건을 만족하는 Product 문서를 조회합니다.

    요청

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

    메서드URI
    GET/products/{product-id}/document

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    product-idStringRequired문서를 조회할 Product ID

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    offsetLongOptional응답 데이터의 시작 지점
    • 0~9,223,372,036,854,775,807
    • limit과 함께 페이지네이션 구현에 사용
    limitLongOptional응답 데이터의 최대 수
    • 1~9,223,372,036,854,775,807
    • offset과 함께 페이지네이션 구현에 사용
    apiNameStringOptionalAPI 이름
    • 0~20자

    요청 예시

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

    curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/document' \
    --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 '{
        "apiName": "api000"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
        "apiPage" : {
            "total" : 6,
            "content" : [ {
                "apiName" : "apiName",
                "domainCode" : "domainCode",
                "stages" : [ {
                    "deployedStageDeploymentNo" : 0,
                    "stageName" : "stageName",
                    "host" : "host",
                    "stageId" : "stageId"
                } ],
                "apiDescription" : "apiDescription",
                "apiId" : "apiId"
            } ]
        }
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "apiPage": {
            "content": [
                {
                    "stages": [
                        {
                            "stageId": "***5ei7***",
                            "stageName": "stage",
                            "deployedStageDeploymentNo": 251***,
                            "host": "https://***ksk9***.apigw.gov-ntruss.com"
                        }
                    ],
                    "apiId": "***51hs***",
                    "apiName": "api000",
                    "apiDescription": "",
                    "domainCode": "GOV"
                }
            ],
            "total": 1
        }
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.