문서 관리하기
등록한 상품에 대한 문서를 작성합니다.
다른 이용자가 상품를 사용할 수 있게 이 문서를 공유할 수 있습니다.
API의 Overview
API에 대한 설명을 Markdown 문법으로 작성합니다.
① My Products > APIs 메뉴로 이동하여 Overview 탭을 선택합니다.
② 입력 탭을 선택하여 문서를 수정할 수 있습니다.
③ 미리보기 탭을 선택하여 작성된 문서를 미리볼 수 있습니다.
④ 저장을 클릭하여 문서를 저장합니다.
Stage의 Document
① My Products > APIs > Stages 메뉴로 이동하여 Document 탭을 선택합니다.
② 미리보기를 클릭하여 작성된 문서를 미리볼 수 있습니다.
Product의 Catalog
상품에 생성된 API의 Overview와 Document를 하나로 묶어 보여줍니다.
이 문서는 다른 사용자에게 공유할 수 있습니다.
① Catalog 아이콘을 클릭합니다.
① 게시한 Stage가 있는 API 목록을 보여줍니다. Stage를 게시하는 방법은 아래의 Catalog 게시하기를 참고하세요.
② API를 선택하면 Overview가 보입니다.
③ Stage에 대한 API 명세를 Swagger UI를 통해 볼 수 있습니다.
④ 수정 버튼을 클릭하여 Overview를 수정할 수 있습니다.
Catalog 게시하기
Product를 다른 사용자가 이용할 수 있도록 문서를 게시합니다.
① My Products 메뉴로 이동하여 게시 아이콘을 클릭합니다.
① API 목록이 조회됩니다. 내가 게시할 API를 선택합니다.
② 게시할 Stage를 선택합니다.
- Stage가 선택되지 않은 API는 Catalog에서 보이지 않습니다.
- 모든 API의 Stage가 선택되지 않으면 Catalog는 다른 사용자에게 보이지 않습니다.
③ 게시 버튼을 클릭합니다.
- Published APIs 메뉴로 이동하여 내가 게시한 상품과 다른 사용자들이 게시한 상품을 함께 조회할 수 있습니다.
API Key 관리하기
Product에 연결된 API Key를 관리합니다.
① My Products 메뉴로 이동하여 API Keys 아이콘을 클릭합니다.
API Key의 상태 변경하기
① 상태 변경을 클릭하여 API Key의 상태를 변경할 수 있습니다.
- 요청: API Key 승인을 요청한 상태입니다.
- 요청거부: API Key 승인 요청을 거부한 상태입니다.
- 승인: API를 호출할 수 있는 상태입니다.
- 거부: 승인된 API Key가 API를 호출할 수 없도록 거부한 상태입니다.
② Usage Plans를 클릭하면 API Keys에 연결된 Usage Plan 정보를 확인할 수 있습니다.
③ 상품에 연결된 API Key의 목록을 조회합니다.
API Key의 Usage Plan 변경하기
① Usage Plan 수정을 클릭하여 API Key에 연결된 Usage Plan을 변경할 수 있습니다.
② API Key가 연결된 Stage의 Usage Plan과 사용량을 확인할 수 있습니다.
① Stage에 연결된 Usage Plan 중에서 변경할 Usage Plan을 선택합니다.
② 저장을 클릭합니다.
