Cloud Endpoints 구성

이 페이지에서는 Endpoints가 관리하는 gRPC 서비스를 만드는 데 필요한 구성 파일을 설명합니다.

기본 요건

이 페이지에서는 먼저 사용자가 다음 작업을 완료했다고 가정합니다.

서비스 이름 선택

Cloud Endpoints는 사용자가 gRPC API 구성 YAML 파일에 구성한 이름을 서비스 이름으로 사용합니다.

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

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

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

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

Google은 cloud.goog 도메인을 소유하고 관리합니다. Google에서 관리하는 도메인을 사용하려면 Google Cloud 프로젝트 ID를 서비스 이름의 일부로 사용해야 합니다. Google Cloud 프로젝트에는 전역에서 고유한 프로젝트 ID가 있으므로 이 요구사항은 고유한 서비스 이름을 갖도록 보장합니다. cloud.goog 도메인을 사용하려면 서비스 이름이 다음 형식이어야 하며 여기에서 YOUR_API_NAME은 API의 이름이고 YOUR_PROJECT_ID는 Google Cloud 프로젝트 ID입니다.

YOUR_API_NAME.endpoints.YOUR_PROJECT_ID.cloud.goog`

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

커스텀 도메인 사용

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

프로토콜 버퍼 구성

  1. 서비스에 사용할 .proto 파일을 만듭니다. 자세한 내용은 개발자 가이드를 참조하세요.

  2. 언어의 protoc 컴파일러를 사용하여 프로토콜 버퍼를 컴파일합니다. 예를 들면 다음과 같습니다.

    protoc
  --proto_path=. \
  --include_imports \
  --include_source_info \
  --descriptor_set_out=api_descriptor.pb \
  bookstore.proto

    앞의 명령어에서 --proto_path는 현재 작업 디렉터리로 설정됩니다. gRPC 빌드 환경에서 .proto 입력 파일에 다른 디렉터리를 사용할 경우 컴파일러가 .proto 파일이 저장된 디렉터리를 검색하도록 --proto_path를 변경합니다.

    설명자 파일을 생성하는 protoc 명령어가 실패할 경우 다음을 확인하세요.

    • protoc 버전이 최신 버전인지 여부
    • 가져온 .proto 파일의 루트 디렉터리로 --proto_path 또는 축약형인 -I를 지정했는지 여부. 자세한 내용은 프로토콜 버퍼 문서를 참조하세요.
    • --include_imports를 지정했는지 여부

    클라이언트에서 JSON이 적용된 HTTP를 사용하여 gRPC 서비스에 액세스하기를 원한다면 JSON이 적용된 HTTP에서 gRPC로 데이터가 전송되는 방법을 지정해야 합니다. .proto 파일에 정의된 API를 주석 처리하는 것이 좋습니다. 자세한 내용은 HTTP/JSON을 gRPC로 트랜스코딩을 참조하세요.

gRPC 서비스 구성 파일 구성

gRPC 서비스 구성 YAML 파일을 만들어야 합니다. 이 파일에서 서비스 이름과 사용 제한(예: API 키 요구 등)을 지정합니다. Bookstore 샘플의 api_config.yaml 파일을 모델로 사용할 수 있습니다.

  1. api_config.yaml 파일의 사본을 저장합니다.

  2. name 필드에 서비스 이름을 입력합니다. 예를 들면 다음과 같습니다.

    name: bookstore.endpoints.example-project-12345.cloud.goog

  3. Google Cloud Console의 Endpoints > 서비스 페이지에 표시되는 제목을 입력합니다. 예를 들면 다음과 같습니다.

    title: Bookstore gRPC API

  4. apis:name 필드에 API 이름을 입력합니다. 입력하는 텍스트는 .proto 파일의 정규화된 API 이름과 정확히 일치해야 합니다. 예를 들면 다음과 같습니다.

    apis:
  - name: endpoints.examples.bookstore.Bookstore

  5. 파일의 나머지를 구성합니다. 예를 들면 다음과 같습니다.

    #
# API usage restrictions.
#
usage:
  rules:
  # ListShelves methods can be called without an API Key.
  - selector: endpoints.examples.bookstore.Bookstore.ListShelves
    allow_unregistered_calls: true

    자세한 내용은 규칙 및 선택기를 참조하세요.

다음 단계

gRPC 추가 샘플