API7 Enterprise v3.3.0, API Portal 지원

Zhihuang Lin

Zhihuang Lin

December 26, 2024

Products

개발자 포털 개요

개발자 포털은 API 소비자(예: 외부 개발자, 내부 팀)를 위해 설계된 전용 플랫폼으로, API 문서, 테스트 도구 및 관련 리소스에 대한 통합 액세스를 제공합니다. 이 포털은 개발자가 API를 빠르게 이해하고 통합할 수 있도록 돕는 동시에 관리 및 보안 수준에서 시각화 및 제어 기능을 향상시킵니다. API 게이트웨이 플랫폼의 경우, 개발자 포털을 제공함으로써 다음과 같은 이점을 얻을 수 있습니다:

  1. API 노출 간소화: 분산된 문서, 예제 및 인터페이스 사양을 하나의 통합 플랫폼으로 통합함으로써 통합 비용을 크게 줄이고 외부 시스템과의 제품 통합 속도를 높입니다.

  2. R&D 및 운영 효율성 향상: 문서 조회, 테스트, 디버깅과 같은 셀프 서비스 기능은 반복적인 커뮤니케이션과 문서 유지 보수를 줄여 전반적인 효율성을 높입니다.

  3. 중앙 집중식 관리 및 모니터링: 플랫폼은 API 사용 추적, 응답 분석 및 주요 지표 모니터링을 더 잘 제공하며 잠재적인 문제를 조기에 감지할 수 있습니다.

API7 Enterprise 3.3.0에서는 API7 게이트웨이가 사용자가 제공한 API 문서에서 직접 개발자 포털을 자동으로 생성하는 기능을 지원합니다. 이 기능을 통해 조직은 API 리소스를 외부에 더 쉽게 노출할 수 있으며 개발자에게 일관되고 편리한 경험을 제공할 수 있습니다.

API7 제공자 포털과 개발자 포털

API 관리 플랫폼으로서, API7 제공자 포털과 개발자 포털은 상호 보완적인 역할을 하지만 다른 대상과 기능을 위해 설계되었습니다.

API7 제공자 포털

API7 제공자 포털은 API 제공자가 API 라이프사이클 관리를 쉽게 수행할 수 있도록 설계된 관리 콘솔입니다.

  • 대상: API 제공자 및 관리자
  • 핵심 기능:
    • API 제품 게시 및 관리.
    • 개발자 관리.
    • 개발자 포털 액세스 정책 구성(예: 익명 API 보기 및 로그인 방법).
    • API 액세스 통계 시각화, 분석 수행 및 로그 추적.

API7 개발자 포털

API7 개발자 포털은 개발자나 파트너가 API 서비스를 빠르게 이해, 액세스 및 활용할 수 있도록 통합된 셀프 서비스 진입점을 제공합니다.

  • 대상: API 소비자, 예를 들어 외부 개발자, 파트너 또는 내부 개발 팀
  • 핵심 기능:
    • API 문서, 사용 가이드 및 예제 코드 제공.
    • 온라인 테스트 및 디버깅 인터페이스 제공.
    • 애플리케이션 등록 관리, API 키 획득 및 인증 자격 증명 처리.

API7 포털 사용 방법

API7 제공자 포털 액세스

API7 Enterprise 대시보드에 로그인한 후, 사용자는 기본적으로 게이트웨이 관리 페이지로 이동합니다. API7 제공자 포털로 전환하려면 왼쪽 상단의 토글 버튼을 클릭하세요. 전환하면 페이지 제목이 API7 제공자 포털로 업데이트되고, 왼쪽 메뉴는 API 제품 관리와 관련된 옵션을 반영합니다.

API7 제공자 포털

API 제품 생성 및 게시

API 제품은 API7 제공자 포털의 핵심 리소스로, 관련된 API 그룹을 나타냅니다. 개발자는 일반적으로 제품 수준에서 API를 구독합니다. API 제품을 생성하는 두 가지 방법이 있습니다.

1. API7 게이트웨이에 게시된 서비스 기반

  • API7 게이트웨이에 게시된 기존 서비스를 선택하고 이를 API 제품으로 그룹화합니다.
  • API 제품 내에서 각 서비스의 해당 경로는 독립적인 API로 처리됩니다.

2. OpenAPI 파일 가져오기

  • 기존 OpenAPI 파일을 가져와 빠르게 API 제품을 생성합니다.
  • 이 방법으로 생성된 제품은 게이트웨이 구성과 직접 연결되지 않습니다.

예제: API7 게이트웨이에서 API 제품 추가

API 제품을 추가하려면 "Add API Product" 버튼을 클릭하고 "From API7 Gateway" 메뉴 항목을 선택하여 API 제품 생성 양식에 액세스합니다.

API 제품 추가

양식에서 다음 정보를 입력해야 합니다:

  1. 기본 정보: 이름, 설명, 라벨, 로고 등.

  2. 인증 유형: 승인이 필요한지 여부를 지정합니다.

  3. 가시성: API 제품의 가시성 범위를 설정합니다.

  4. 연결된 게이트웨이 서비스: 다음 두 조건을 충족하는 게시된 게이트웨이 서비스를 선택합니다:

    • 호스트 이름이 구성되어 있습니다.
    • OpenAPI 문서가 업로드되어 있습니다.

새로운 API 제품 추가

요구 사항을 충족하는 서비스가 없는 경우 아래 구성 단계를 따를 수 있습니다.

1. 기존 서비스에 OpenAPI 문서 업로드 및 호스트 이름 구성

OpenAPI 사양 구성

서비스 세부 정보 또는 서비스 템플릿 페이지에서 왼쪽 탐색 바의 OpenAPI Specification을 클릭합니다. 그런 다음 서비스에 해당하는 OpenAPI 문서를 업로드합니다. 문서의 API 정의가 서비스의 실제 경로와 정확히 일치하는지 확인합니다. 이렇게 하면 개발자가 디버깅 중에 정확한 API 문서를 얻고 업스트림 액세스에 성공할 수 있습니다.

OpenAPI 사양 업로드

문서를 업로드한 후 실시간으로 미리 볼 수 있으며, 이는 개발자가 액세스할 최종 API 문서와 동일합니다.

OpenAPI 사양 보기

다음으로, 서비스 세부 정보 또는 템플릿 세부 정보 페이지의 Routes 섹션에서 Request URL 모듈의 hosts를 구성합니다. 기본적으로 hosts는 **"*"**로 설정되어 있으며, 이는 서비스가 모든 호스트 이름의 요청을 처리함을 의미합니다.

요청 URL

서비스를 API 제품에 연결하려면 정확한 호스트를 지정해야 합니다. 이 요구 사항은 개발자가 host + path prefix + API 형식의 전체 경로를 사용하여 API에 액세스할 수 있도록 보장합니다.

2. API 제품에 연결할 새 서비스 생성

서비스 추가

게시된 서비스가 없는 경우, OpenAPI 문서를 서비스 템플릿으로 업로드하여 게시하거나 게이트웨이 그룹에서 직접 서비스를 생성할 수 있습니다. 이 방법으로 생성된 서비스는 OpenAPI 정의된 API를 경로로 자동 파싱하며, 문서를 다시 업로드할 필요 없이 유지합니다. 앞서 설명한 대로 host를 구성하여 서비스를 API 제품 연결에 적합하게 만듭니다.

게이트웨이 구성이 완료되면 제공자 포털로 돌아가 Add Linked Gateway Service를 클릭합니다. 필요한 게시된 서비스를 선택하여 연결을 완료합니다.

연결된 게이트웨이 서비스 추가

기본적으로 새로 생성된 API 제품은 초안 상태이며 개발자에게 보이지 않습니다. 게시하기 전에 API 문서, 가시성 설정 및 인증 설정을 검토하세요. API 제품 이벤트 알림(예: 구독 승인 또는 취소)을 구성하여 중요한 업데이트를 놓치지 않도록 하는 것이 좋습니다.

API 제품 게시

API 제품을 검증한 후, 오른쪽 상단의 Publish 버튼을 클릭하고 확인합니다. 가시성 설정에 맞는 개발자는 개발자 포털을 통해 제품에 액세스할 수 있습니다.

API 제품 게시

API7 개발자 포털 액세스

API7 개발자 포털에 액세스하는 두 가지 방법이 있습니다:

  1. 개발자 포털의 URL을 방문합니다.
  2. API7 포털 대시보드의 왼쪽 메뉴에서 Developer Portal 버튼을 클릭합니다.
개발자 포털 진입

API7 개발자 포털의 홈페이지에서 오른쪽 상단의 Login 버튼을 클릭하여 로그인합니다.

개발자 포털 로그인

개발자 생성

개발자 계정을 생성하는 두 가지 방법이 있습니다:

  • 셀프 등록: 개발자가 로그인 페이지에서 직접 등록합니다.
  • 관리자 초대: 관리자가 API7 포털 대시보드를 통해 계정을 생성합니다.

셀프 등록

로그인 페이지에서 Sign up 버튼을 클릭하고, 사용자 이름과 비밀번호를 입력하여 양식을 완료합니다.

개발자 등록

관리자 주도 등록

API7 포털 대시보드에서 Developers 섹션으로 이동하여 Invite Developer를 클릭합니다. 사용자 이름과 일회용 비밀번호를 입력하고, 필요에 따라 식별을 위한 표시 이름을 제공합니다.

개발자 초대

개발자를 추가한 후, 사용자에게 사용자 이름과 비밀번호를 공유합니다. 첫 로그인 시 비밀번호를 재설정해야 합니다.

비밀번호 재설정

API 제품 보기

로그인 후, 개발자는 API Hub를 클릭하여 게시된 모든 API 제품을 볼 수 있습니다.

API 제품 보기

API 문서 보기 외에도, 시스템은 각 API의 상세 페이지에서 다국어 코드 샘플을 생성하는 기능을 지원합니다. 개발자는 이러한 샘플 코드를 개발 환경에 복사하여 테스트할 수 있습니다.

API 제품 상세 보기

API 제품 디버깅

또한, 개발자는 Test Request 버튼을 클릭하여 API를 직접 테스트할 수 있습니다.

API 제품 테스트

Test Request를 클릭한 후, 온라인 테스트 패널을 볼 수 있습니다.

  • Request URL은 API 제품과 연결된 서비스 구성을 기반으로 자동 생성됩니다.
  • Authentication Method는 기본적으로 Key Auth로 설정되며, 현재 개발자 계정의 API 키를 자동으로 채웁니다.

개발자는 API 인터페이스 정의에 따라 필요한 요청 매개변수를 보충하여 디버깅을 진행할 수 있습니다.

매개변수 수정 및 API 제품 테스트

API 제품 구독

API 제품이 특정 사용자에게 제한된 경우, 제공자 포털의 관리자는 제품의 가시성 설정에서 Unsubscribed developers can view API details 옵션을 비활성화할 수 있습니다. 이렇게 하면 개발자가 API에 액세스하거나 호출하기 전에 제품을 구독해야 합니다.

API 제품 가시성 편집

이 설정에서 개발자가 API 제품 상세 페이지에 액세스하면 "Subscribe to Unlock" 버튼이 표시됩니다. 버튼을 클릭하면 제공자 관리자에게 구독 요청이 전송됩니다.

구독하여 잠금 해제

API 제품에 대해 승인 프로세스가 활성화된 경우, 개발자는 관리자의 승인을 기다린 후 상세 정보를 볼 수 있습니다.

승인 대기 중

API7 제공자 포털의 Organization 메뉴에서 보류 중인 승인이 있는 경우, Approvals 메뉴 항목 옆에 빨간 점이 표시됩니다. 이 메뉴 항목을 클릭하면 승인 관리 페이지로 이동합니다.

Organization 아래의 승인

승인 페이지는 개발자가 API 리소스에 액세스하기 위한 요청을 관리하기 위해 설계되었습니다. 관리자는 이 페이지에서 다음 요청 정보를 검토할 수 있습니다: 이벤트 유형, 리소스 이름, 신청자 및 신청 시간. 인터페이스를 통해 관리자는 요청을 승인하거나 거부할 수 있습니다.

승인 결정은 개발자의 API 액세스 권한에 직접적인 영향을 미칩니다:

  • 승인: 개발자는 API 제품 상세 페이지를 보고 API를 호출할 수 있습니다.
  • 거부: 개발자는 관리자와 커뮤니케이션하고 피드백을 바탕으로 필요한 조정을 한 후 요청을 다시 제출해야 합니다.

보류 중인 승인

결론

API7 Enterprise는 API 게이트웨이 플랫폼과 개발자 포털을 통합하여 API 제공자와 개발자 모두를 위한 효율적인 API 관리 솔루션을 제공합니다.

API7 제공자 포털은 API 제공자가 API 제품을 쉽게 게시, 관리 및 모니터링할 수 있도록 하며, 개발자 리소스를 효과적으로 조정합니다. 한편, 개발자는 API 서비스를 빠르게 이해, 통합 및 효율적으로 활용하여 애플리케이션 개발 속도를 높일 수 있습니다. 이 두 포털은 API 라이프사이클 관리 프로세스를 간소화하여 배포부터 호출까지의 각 단계를 더 원활하고 효율적으로 만듭니다.

Tags:
API Portal
API7 Enterprise