Developer Portal API Product Publication
개요
이 튜토리얼은 개발자 포털에서 API 제품을 생성하고 게시하는 과정을 안내합니다. APIM의 제품은 여러 API를 그룹화하고 제목, 설명, 로고 및 문서 링크와 같은 제품 수준의 메타데이터를 정의할 수 있게 해줍니다. 게시된 제품은 개발자가 발견하고 사용할 수 있도록 표시됩니다.
전제 조건
- APIM 콘솔에서 사용할 수 있는 배포된 API가 최소 하나 이상 필요합니다.
- Admin > Product Management에 대한 관리자 액세스 권한이 필요합니다.
단계별 튜토리얼
단계 1. 새 제품 만들기
Admin > Product Management로 이동한 다음, 더하기 버튼을 클릭합니다.
팝업에서:
- 제품 이름 입력: sk01
- 진행하려면 확인을 클릭합니다.
단계 2. 기본 제품 정보 입력
제품을 생성한 후, 세부 정보 페이지로 리디렉션됩니다.
| Field | Example |
|---|---|
| 이름 | sk01 (자동 입력) |
| 설명 | 인증 및 사용자 관리 API |
| 제품 소개 링크 | https://developers.skapim.co.kr/product/sk01/overview |
| 제품 활성화 체크 | (개발자 포털에 표시됨) |
| API 문서 링크 활성화 체크 | (제품 세부 정보 페이지에서 API 문서 접근 활성화) |
| 제품 아이콘 | icon-sk01.png (1:1 비율, 표시 크기 40x40px) |
기본 정보를 저장하려면 저장을 클릭합니다.
단계 3. 제품에 API 추가
제품 세부 정보 보기에서 API 탭으로 전환합니다.
이 제품에 API를 할당하려면 추가 버튼을 클릭합니다.
사용 가능한 API 필드:
| 필드 | 예시 |
|---|---|
| 프로젝트 | mj-test-kong |
| 게이트웨이 | mj-test-kong-gateway |
| API | testFromBff0052 |
| 설명 | helloworld2222 |
| 태그 |
추가를 완료하려면 체크 아이콘을 클릭합니다.
다음과 같은 작업을 수행할 수 있습니다:
- 여러 API 추가
- API 제거 (X 아이콘)
- 각 API를 보거나 편집하기 (기어 또는 보기 아이콘)
4단계. 개발자 포털에서 제품 활성화
제품 목록으로 돌아가면 새로운 항목이 표시됩니다.
| 열 | 설명 |
|---|---|
| 체크박스 | 개발자 포털에서 제품을 게시하거나 숨기기 위한 토글 |
| 순서 | 제품 목록에서 표시 순서를 정의 (0 = 상단) |
표시 위치를 편집한 후 주문 저장을 클릭하세요.
모범 사례
- 제품 이름은 의미 있고 고유하게 유지하세요.
- 일관된 표시를 위해 1:1 비율 아이콘 (40x40px)을 사용하세요.
- 관련 API를 단일 제품으로 그룹화하여 쉽게 찾을 수 있도록 하세요.
- 제품 소개 링크를 사용하여 사용자를 문서 또는 비즈니스 개요에 연결하세요.
- 내부 조직 및 프론트엔드 필터를 위해 태그를 사용하세요.