API 게이트웨이에 Cloud Endpoints API 배포

Cloud Endpoints는 API에서 보안, 모니터링, 분석, 할당량 설정을 도와주는 API 관리 시스템입니다. Endpoints는 Extensible Service Proxy (ESP) 또는 Extensible Service Proxy V2 (ESPv2)를 사용하여 API를 호스팅합니다.

Endpoints를 사용할 때는 세 가지 옵션에 따라 API를 정의할 수 있습니다.

API 게이트웨이로 API 개발

Endpoints와 API 게이트웨이는 모두 OpenAPI 사양(OpenAPI 2.0 또는 OpenAPI 3.x)을 사용하여 설명된 API를 지원합니다. OpenAPI를 사용하여 Endpoints API를 정의한 경우 API 게이트웨이에 Endpoints API를 배포할 수도 있습니다.

API 게이트웨이에 Endpoints OpenAPI 사양 배포

API 게이트웨이는 OpenAPI용 Cloud Endpoints에서 지원되는 것과 동일한 OpenAPI 사양 정의 형식 및 옵션을 지원합니다. 즉, Endpoints OpenAPI 사양의 동일한 보안, 할당량, 기타 정의를 사용해서 API 게이트웨이에서 API를 정의할 수 있습니다.

Endpoints와 API 게이트웨이의 유일한 차이점은 OpenAPI 사양 정의에서 host 속성을 처리하는 방식입니다.

  • Endpoints에서는, ESP 또는 ESPv2를 배포할 때 생성된 URL의 호스트 이름 부분으로 host 속성을 설정합니다. 여기에서 ESP 또는 ESPv2는 Endpoints API를 호스팅하기 위해 사용되는 서비스입니다.
  • API 게이트웨이에서는 host를 생략하거나 배포된 API의 DNS 이름으로 설정합니다. API 제공업체는 OpenAPI 사양을 API 소비자와 공유할 때 이를 DNS 이름으로 설정하는 경우가 많습니다. 하지만 API 게이트웨이는 host 속성의 값을 강제 적용하지 않습니다.

예를 들어 다음은 Cloud Run 함수에 배포된 백엔드 서비스에 액세스하도록 API를 정의하기 위해 Endpoints에서 사용되는 OpenAPI 정의의 일부입니다.

OpenAPI 2.0

swagger: '2.0'
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
host: HOST
schemes:
  - https
  ...

OpenAPI 3.x

openapi: 3.0.4
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
servers:
- url: https://HOST
  x-google-endpoint: {}
...

API 정의에 대한 OpenAPI 사양 만들기는 OpenAPI 개요를 참조하세요.

다음 단계