Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보
API 제공업체는 API를 노출하고, 개발자에게 API에 관해 안내하고, 개발자를 가입시키고, 개발자가 앱을 등록할 수 있는 방법이 필요합니다. Apigee Edge는 개발자 커뮤니티에 이러한 서비스를 제공하기 위해 맞춤설정된 자체 웹사이트를 빌드하고 출시하는 데 사용할 수 있는 개발자 서비스 포털을 제공합니다. 개발자 포털에 대해 자세히 알아보려면 개발자 포털이란 무엇인가요?를 참고하세요.
다음 섹션에서는 개발자 포털 문제를 해결하기 전에 알아야 하는 주요 개념을 설명합니다.
SmartDocs 작동 방식
API를 설명하는 OpenAPI (JSON 또는 YAML) 또는 WADL 사양을 SmartDocs로 가져와 포털에 API 참조 문서를 게시하는 데 사용할 수 있습니다. API 참조 문서는 포털의 API 탭 아래에 자동으로 표시됩니다. 개발자는 포털을 통해 API 문서를 찾고 실시간 API 요청을 할 수 있습니다. API 요청은 브라우저에서 발생하므로 요청이 성공하려면 CORS (교차 출처 리소스 공유) 지원이 필요합니다. CORS 지원은 의도한 엔드포인트에 대한 모든 SmartDocs 요청의 프록시 역할을 하는 Edge의 'smartdocs' 프록시('VALIDATE' 조직)에서 제공합니다. 'smartdocs' 프록시는 SmartDocs를 설치할 때 생성됩니다.
예를 들면 다음과 같습니다.
SmartDocs 프록시의 URL은 구성 -> SmartDocs -> SmartDocs 프록시 URL에서 구성 가능한 속성으로 노출됩니다. API가 비공개 네트워크에 있고 포털에서 SmartDocs를 사용하여 실시간 API 요청이 실패하는 경우 이 URL을 수정해야 할 수 있습니다.
개발자 포털이 Edge와 통신하는 방법
개발자 포털은 Smartdocs, 개발자, 제품, 개발자 앱을 비롯하여 Edge에서 표시하는 대부분의 정보를 저장하고 검색합니다. Edge 조직 정보 및 개발자 관리자 사용자 인증 정보는 메뉴 명령어 구성 -> Devportal을 사용하여 구성할 수 있습니다.
자세한 내용은 포털과 Edge 간의 통신을 참고하세요.