Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보
게시는 API를 사용할 수 있도록 앱 개발자에게 제공하는 프로세스입니다.
동영상: 다음 동영상은 API 게시를 개략적으로 소개합니다.
API 게시에는 이 주제에서 설명하는 다음 작업이 포함됩니다.
- Edge에서 API를 번들로 제공하는 API 제품을 만듭니다.
- Edge에서 앱 개발자를 등록합니다.
- Edge에서 개발자 앱을 등록합니다.
- API 관련 문서 및 커뮤니티 지원 제공
작업 1: Edge에서 API 제품 만들기
게시의 첫 번째 작업은 API 제품을 만드는 것입니다. API 제품은 앱 개발자에게 사용하라고 패키지로 제공하는 API 리소스 모음입니다. Edge 관리 API 또는 UI를 사용하여 API 제품을 만듭니다. API 제품에 대한 자세한 내용은 API 제품이란 무엇인가요?를 참조하세요.
이 그림에서 API는 각각 3개의 API 리소스를 포함하는 두 개의 제품으로 구성됩니다.
API 제공업체는 액세스 제어, 사용 제한, 기타 비즈니스 요구사항을 처리하기 위해 API와 API 제품을 빌드할 책임이 있습니다. 예를 들면 다음과 같은 작업을 수행할 수 있습니다.
- API 리소스에 대한 읽기 전용 액세스 권한을 허용하는 무료 API 제품을 출시합니다.
- 무료 버전과 동일한 API 리소스에 대한 읽기/쓰기 액세스를 허용하지만 하루 요청 1,000건으로 액세스 제한이 낮은 두 번째 API 제품을 저렴한 가격으로 출시합니다.
- 동일한 API 리소스에 대한 읽기/쓰기를 허용하지만 액세스 제한이 높은 세 번째 API 제품을 더 높은 가격으로 출시합니다.
중요한 점은 Edge를 사용하면 API의 비즈니스 요구사항과 일치하는 API 제품을 유연하게 만들 수 있다는 것입니다.
API 제품을 만드는 방법에 대한 자세한 내용은 API 제품 만들기를 참고하세요.
작업 2: Edge에서 앱 개발자 등록
개발자가 API를 사용하는 앱을 만듭니다. 앱 개발자는 앱을 등록하기 전에 본인을 Apigee Edge에 등록합니다. 앱을 등록하면 API에 대한 액세스 권한을 앱에 부여하는 API 키가 발송됩니다.
앱 등록 프로세스를 통해 API에 액세스할 수 있는 사용자를 지정할 수 있습니다. 언제든지 앱 개발자를 삭제할 수 있습니다. 삭제하면 개발자와 연결된 모든 API 키가 무효화되어 API에 대한 개발자의 액세스가 거부됩니다.
API 제공업체는 잠재적 개발자를 등록하는 방법을 결정합니다. 예를 들어 잠재적 개발자가 조직에 문의하여 등록해야 하는 수동 등록 프로세스를 사용할 수 있습니다. 잠재적 개발자는 이메일 주소, 이름, 회사 이름 등 필요한 모든 정보를 제공해야 합니다. 개발자 요청을 승인하면 Edge 관리 UI를 사용하여 개발자를 직접 등록할 수 있습니다. 자세한 내용은 앱 개발자 관리를 참고하세요.
Apigee는 개발자 등록 프로세스를 자동화하는 데 사용할 수 있는 도구도 제공합니다. 예를 들면 다음과 같습니다.
- Apigee Edge 관리 API를 사용하여 등록 기능을 기존 웹사이트에 통합합니다. Edge Management API는 개발자 등록 프로세스의 모든 측면을 실행하는 데 사용할 수 있는 REST API입니다. 자세한 내용은 Edge 관리 API를 사용하여 API 게시를 참고하세요.
- Apigee Developer Services 포털을 사용하여 개발자를 등록합니다. 포털에는 개발자 등록을 위한 기본 지원 기능이 있지만 API를 지원하는 다른 많은 기능도 있습니다. 자세한 내용은 개발자 포털이란 무엇인가요?를 참고하세요.
작업 3: Edge에서 개발자 앱 등록
앱이 API에 액세스하려면 먼저 앱을 Edge에 등록해야 합니다. 그러나 등록된 개발자만 Edge에 앱을 등록할 수 있습니다.
앱을 등록할 때 개발자는 하나 이상의 API 제품을 선택합니다. 예를 들어 다양한 유형의 서비스 및 요금제에 해당하는 여러 API 제품을 게시할 수 있습니다. 그러면 앱 개발자가 사용 가능한 API 제품 목록에서 선택할 수 있습니다.
Edge에 앱을 등록하면 Edge는 앱에 고유한 API 키를 할당합니다. 앱은 API 리소스에 대한 모든 요청의 일환으로 API 키를 전달해야 합니다. 키가 인증되고 유효하면 요청이 부여됩니다. 앱이 API에 액세스할 수 없도록 서비스 제공업체가 언제든 키를 취소할 수 있습니다.
API 제공업체는 앱을 등록하는 방법을 결정합니다. 다음과 같은 방법을 사용할 수 있습니다.
- 수동 프로세스를 사용하여 개발자가 조직에 연락하여 앱을 등록하도록 합니다. 그러면 개발자에게 API 키가 이메일로 전송됩니다.
- Edge Management API를 사용하여 앱 등록 기능과 키 전달을 웹사이트에 통합합니다.
- 유료 Edge 계정의 경우 앱 등록 및 API 키 전송을 기본적으로 지원하는 Apigee 개발자 서비스 포털을 사용합니다.
자세한 내용은 앱 등록 및 API 키 관리를 참조하세요.
작업 4: API 문서화
API 제품 게시 시 중요한 고려사항은 문서 및 개발자 의견 메커니즘을 제공하는 것입니다. 소셜 게시 기능이 있는 개발자 포털은 개발 커뮤니티와의 커뮤니케이션에 점점 더 많이 사용되고 있습니다. 여기에는 API 문서 및 이용약관 같은 정적 콘텐츠와 블로그 및 포럼 같은 동적 커뮤니티 제공 콘텐츠의 커뮤니케이션은 물론 고객 지원 기능이 포함됩니다.
자체 웹사이트를 빌드하여 문서를 배포할 수 있습니다. 유료 Edge 계정이 있는 경우 Apigee 개발자 서비스 포털을 사용할 수 있습니다. 포털에는 개발자 커뮤니티를 지원하는 데 필요한 문서, 블로그, 포럼, 기타 콘텐츠 유형에 대한 지원 기능이 내장되어 있습니다.
SmartDocs를 사용하면 API 문서를 완전히 상호 작용하는 방식으로 개발자 서비스 포털에 문서화할 수 있습니다. SmartDocs가 포함된 대화형 문서를 통해 포털 사용자는 다음 작업을 수행할 수 있습니다.
- API 관련 문서 읽어보기
- API에 실시간 요청 보내기
- API에서 반환된 실시간 응답 보기
예를 들어 다음 그림은 SmartDocs를 사용하여 포털에 문서화된 API를 보여줍니다. 이 API는 특정 위치의 날씨 정보를 제공합니다.
개발자는 'w' 쿼리 매개변수의 값을 입력하여 위치를 지정한 다음 요청 전송 버튼을 클릭하여 실시간 요청과 응답을 확인합니다. API에 관한 대화형 문서를 만들면 포털 사용자가 API를 쉽게 학습, 테스트, 평가할 수 있습니다.
Edge 관리 API는 모든 HTTP 클라이언트를 사용하여 API 서비스에 액세스할 수 있는 REST API입니다. Apigee는 SmartDocs를 사용하여 Edge 관리 API용 양방향 문서를 만듭니다. 여기에서 API 문서를 확인하세요.
자세한 내용은 SmartDocs를 사용하여 API 문서화를 참고하세요.