Published APIs

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

Product의 API 문서를 공유하거나 다른 사용자가 공유한 API 문서를 구독할 수 있습니다.

Published APIs 화면 및 목록

API Gateway 이용을 위한 Published APIs 메뉴의 기본적인 설명은 다음과 같습니다.

영역	설명
① 메뉴명	현재 확인 중인 메뉴 이름, 구독 가능한 Product 개수
② 기본 기능	API Gateway 상세 정보 확인, 페이지 새로 고침
③ Catalog	사용자 및 다른 사용자가 공유한 API 문서 확인 및 구독
④ 검색창	Product 이름 입력한 후 을 클릭해 항목 검색
⑤ 필터	API 제공 위치(기본값: NCP), 구독 여부를 기준으로 항목 필터링 네이버 클라우드 플랫폼에서 제공하는 API 이외의 다른 API 목록을 조회하려면 필터 변경 사용자가 게시한 API를 검색하려면 My를 선택
⑥ 정렬	목록 페이지당 표시할 API 개수 설정
⑦ 목록	사용자 및 다른 사용자가 공유한 API 목록 Product 이름: 게시된 Product 이름 설명: 게시된 Product에 대한 설명 구독 방식: 게시된 Product의 구독 방식(공개, 보호) 구독: 게시된 Product에 대한 사용자의 구독 여부

Catalog 보기

Product에 생성된 API의 Overview를 확인하고, Stage의 Document를 Swagger UI를 통해 확인할 수 있습니다.
사용자가 게시한 API의 경우 Overview 내용을 수정할 수 있습니다.

게시된 API의 Overview 및 Document를 확인하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. Published APIs 메뉴를 클릭해 주십시오.
3. 게시된 Product 목록에서 정보를 확인할 Product를 클릭해 선택한 후 [Catalog] 버튼을 클릭해 주십시오.
   • 네이버 클라우드 플랫폼에서 제공하는 API 이외의 다른 API 목록을 조회하려면 필터의 Product 항목을 변경해 주십시오.
4. Product의 Catalog 목록에서 확인할 API 이름을 클릭해 주십시오.
5. 조회 상세 화면에서 API의 Overview와 Stage의 Document를 확인해 주십시오.
   • 사용자가 직접 생성한 API의 경우, Overview 내용을 수정할 수 있는 [수정] 버튼이 표시됩니다. 수정하려면 [수정] 버튼을 클릭한 후 내용을 작성한 다음 [저장] 버튼을 클릭해 주십시오. Overview 작성에 대한 자세한 내용은 API 설명서의 Overview 작성을 참고해 주십시오.
   • Stage의 Document 내용을 Swagger UI를 통해 확인하려면 Stage 이름 또는 을 클릭해 주십시오.

Catalog 구독 신청

게시된 Product의 구독 방식은 공개와 보호가 있습니다.

• 공개: 승인 절차 없이 누구나 Product의 API를 호출 가능하며, 해당 Catalog 목록 화면에 [구독하기] 버튼이 표시되지 않음
• 보호: Product의 API를 사용하기 위해서는 게시자의 승인이 필요하며, 해당 Catalog 목록 화면에 [구독하기] 버튼이 표시됨

게시된 Product의 구독 방식이 보호인 경우, 구독하려면 API Key를 생성한 후 API Key 승인 절차를 거쳐야 합니다.

Catalog 구독을 신청하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
2. Published APIs 메뉴를 클릭해 주십시오.
3. Published APIs 메뉴에서 구독 타입이 보호인 Product를 클릭해 선택한 후 [Catalog] 버튼을 클릭해 주십시오.
4. Product의 Catalog 목록에서 [구독하기] 버튼을 클릭해 주십시오.
5. 구독 신청할 API에 대해 인증받을 API Key를 선택한 후 [구독 요청] 버튼을 클릭해 주십시오.
6. 구독하기 팝업 창에서 [구독 요청] 버튼을 클릭해 주십시오.
   • 구독 신청이 완료되면 해당 Product의 구독 열의 표시값이 미구독에서 요청으로 변경됩니다.
   • 구독 상태는 API Keys 메뉴의 연결된 Stage 목록에서도 확인할 수 있습니다.
   • API 구독 상태에 대한 자세한 내용은 API Key의 상태 변경을 참고해 주십시오.
   • API 구독을 취소하려면 API Keys 메뉴의 Stage 연결 해제(구독 취소)를 참고해 주십시오.