Cloud Endpoints 포털 개요

Cloud Endpoints 포털을 사용하여 Cloud Endpoints API 사용자가 액세스하여 API를 탐색하고 테스트할 수 있는 웹사이트인 개발자 포털을 만들 수 있습니다. 포털에서는 각자의 고유 코드에서 API를 사용하는 개발자가 SmartDocs API 참조 문서를 확인할 수 있습니다. SmartDocs는 gRPC 서비스 구성을 사용하여 API 참조 문서를 생성합니다. SmartDocs에는 API 사용해 보기 패널이 포함되어 있어, 개발자가 문서에서 나가지 않고도 API와 상호작용할 수 있습니다.

포털

또한 사용자의 시작하기와 API의 성공적인 사용을 돕기 위해 자신만의 커스텀 문서를 제공할 수도 있습니다.

Cloud Endpoints 포털 데모를 방문하면 여러 Cloud Endpoints 샘플에서 생성된 포털을 살펴볼 수 있습니다.

제한사항

  1. 사용자가 개발자 포털에 액세스하려면 GCP 프로젝트로 인증해야 합니다. 인증되지 않은 사용자는 개발자 포털을 볼 수 없습니다.
  2. 이 API 사용해 보기 패널을 사용하려면 엔드포인트 서비스에 공개적으로 액세스할 수 있어야 합니다. IAP와 같은 다른 인증이 Endpoints 서비스에 구성되어 있으면 요청이 실패합니다.
  3. Endpoints 포털은 단일 Endpoints 배포의 개별 네임스페이스에 선언된 동일한 이름의 메시지 또는 서비스를 지원하지 않습니다. 이는 Endpoints로 API 버전 관리 권장사항을 따르는 사용자에게 영향을 줄 수 있습니다. 메시지 또는 서비스의 잘못된 버전 관리를 방지하려면 다음 방법 중 하나를 사용하세요.
    • 모든 .proto 파일의 모든 메시지 및 서비스에 고유한 이름을 지정합니다. 예를 들어 버전 1에서는 data 메시지 data1를, 버전 2에서는 data2 메시지 이름을 지정합니다.
    • API 버전을 서로 다른 Endpoints 배포로 분리합니다.

다음 단계