Cloud Endpoints 구성

Cloud Endpoints는 OpenAPI 사양 버전 2.0을 사용하여 기술된 API를 지원합니다. OpenAPI 문서에서 API 노출 영역을 설명하고 Endpoints 기능(예: 인증 규칙 또는 할당량)을 구성합니다.

Endpoints는 OpenAPI 문서에서 특별히 다음과 같은 필수 필드를 사용합니다.

  • host
  • info.title
  • info.version
  • operationId

이 페이지에서는 Endpoints가 위와 같은 필드를 사용하는 방법에 대해 설명합니다. 이 정보를 통해 배포용 OpenAPI 문서의 작성을 완료할 수 있습니다.

기본 요건

이 페이지에서는 아래 작업이 이미 완료되었다고 가정합니다.

host

Cloud Endpoints는 OpenAPI 문서의 host 필드에 서비스 이름으로 구성된 이름을 사용합니다.

API 서비스 이름은 Google Cloud에서 고유해야 합니다. Endpoints는 DNS 호환 이름을 사용하여 서비스를 식별하므로 API의 도메인 이름 또는 하위 도메인 이름을 서비스 이름으로 사용하는 것이 좋습니다. 이 방법을 따르면 Endpoints 서비스 페이지에 표시되는 서비스 이름이 API에 대한 요청에 사용된 이름과 일치하게 됩니다. 또한 서비스 이름과 도메인 이름이 같은 경우 API 사용자를 위한 Cloud Endpoints 포털을 만들 수 있습니다. Endpoints의 서비스 이름 요구사항은 다음과 같습니다.

  • 도메인 이름 최대 길이는 253자(영문)입니다.
  • 도메인 이름은 소문자로 시작해야 합니다.
  • 점으로 구분된 도메인 이름의 각 섹션은 다음과 같은 요구사항을 충족해야 합니다.
    • 소문자로 시작해야 합니다.
    • 대시로 끝나서는 안 됩니다.
    • 나머지 문자는 소문자, 숫자 또는 대시일 수 있습니다.
    • 최대 길이는 63자입니다.

사용자 고유의 커스텀 도메인(예: example.com)을 등록하거나 Google에서 관리하는 도메인을 사용할 수 있습니다.

Google에서 관리하는 도메인 사용

Google은 cloud.googappspot.com 도메인을 소유하고 관리합니다. Google에서 관리하는 도메인을 사용하려면 Google Cloud 프로젝트 ID를 서비스 이름의 일부로 사용해야 합니다. Google Cloud 프로젝트에는 전역에서 고유한 프로젝트 ID가 있으므로 이 요구사항은 고유한 서비스 이름을 갖도록 보장합니다.

사용되는 도메인 이름은 API를 호스팅할 백엔드에 따라 결정됩니다.

  • App Engine 가변형 환경에서 호스팅되는 API의 경우 appspot.com 도메인을 사용해야 하고, 서비스 이름은 다음 형식(여기서 YOUR_PROJECT_ID는 Google Cloud 프로젝트 ID)을 따라야 합니다.

    YOUR_PROJECT_ID.appspot.com
    

    App Engine에 API를 배포하면 YOUR_PROJECT_ID.appspot.com 형식의 이름을 가진 DNS 항목이 자동으로 생성됩니다.

  • Compute Engine, Google Kubernetes Engine, Kubernetes에서 호스팅되는 API의 경우 cloud.goog 도메인을 사용해야 하고, 서비스 이름은 다음 형식(여기서 YOUR_API_NAME은 API 이름)을 따라야 합니다.

    YOUR_API_NAME.endpoints.YOUR_PROJECT_ID.cloud.goog
    

    이 도메인을 API의 도메인 이름으로 사용하려면 cloud.goog 도메인에서 DNS 구성을 참조하세요.

커스텀 도메인 사용

Google에서 관리하는 도메인을 사용하지 않으려면 사용 권한이 있는 커스텀 도메인(예: myapi.mycompany.com)을 사용할 수 있습니다. API 구성을 배포하기 전에 도메인의 소유권 확인 단계를 따르세요.

info.title

info.title 필드는 API의 사용자 친화적인 이름입니다. Cloud Console의 Endpoints > 서비스 페이지에는 info.title 필드에 구성한 텍스트가 표시됩니다. Cloud 프로젝트별로 API가 2개 이상 있으면 페이지를 처음 열 때 API 이름이 목록에 표시됩니다. API의 이름을 클릭하면 API의 측정항목, 배포 기록, 기타 정보가 표시된 또 다른 페이지가 열립니다.

info.version

Cloud Console의 엔드포인트 > 서비스 페이지에 API의 버전 번호가 표시됩니다. API 구성을 처음으로 배포하기 전에 다음을 수행하세요.

  • info.version 필드의 버전 번호를 해당 API 버전으로 설정합니다(예: 1.0).

  • basePath 필드를 주 버전 번호로 설정합니다(예: /v1).

API 버전 관리에 관한 자세한 내용은 API 수명 주기 관리를 참조하세요.

operationId

OpenAPI 사양에서 operationId 필드는 선택사항이지만, Endpoints에서는 내부적으로 작업을 식별하는 데 이 ID를 사용하므로 필수 항목입니다. operationId에 사용하는 문자열은 API 내에서 고유해야 합니다. 이름 지정에 관한 가이드는 OpenAPI 사양에서 operationId에 관한 설명을 참조하세요.

다음 단계