Men-deploy API Cloud Endpoints di API Gateway

Cloud Endpoints adalah sistem pengelolaan API yang membantu Anda mengamankan, memantau, menganalisis, dan menetapkan kuota pada API Anda. Endpoints menggunakan Extensible Service Proxy (ESP) atau Extensible Service Proxy V2 (ESPv2) untuk menghosting API Anda.

Saat menggunakan Endpoints, Anda memiliki tiga opsi untuk menentukan API:

Mengembangkan API dengan API Gateway

Endpoints dan API Gateway mendukung API yang dideskripsikan menggunakan spesifikasi OpenAPI, OpenAPI 2.0 atau OpenAPI 3.x. Jika Anda telah menggunakan OpenAPI untuk menentukan API Endpoints, berarti Anda juga dapat men-deploy API Endpoints di API Gateway.

Men-deploy spesifikasi OpenAPI Endpoints di API Gateway

API Gateway mendukung format dan opsi definisi spesifikasi OpenAPI yang sama seperti yang didukung oleh Cloud Endpoints untuk OpenAPI. Artinya, Anda dapat menggunakan keamanan, kuota, dan definisi lainnya yang sama dari spesifikasi OpenAPI Endpoints untuk menentukan API di API Gateway.

Satu-satunya perbedaan antara Endpoints dan API Gateway adalah cara keduanya memproses properti host dalam definisi spesifikasi OpenAPI:

  • Di Endpoints, tetapkan properti host ke bagian nama host dari URL yang dibuat saat Anda men-deploy ESP atau ESPv2, dengan ESP atau ESPv2 adalah layanan yang digunakan untuk menghosting Endpoints API Anda.
  • Di API Gateway, hapus host atau tetapkan ke nama DNS API yang di-deploy. Penyedia API sering menyetelnya ke nama DNS saat membagikan spesifikasi OpenAPI kepada konsumen API mereka. Namun, API Gateway tidak menerapkan nilai properti host.

Misalnya, berikut adalah sebagian definisi OpenAPI yang digunakan oleh Endpoints untuk menentukan API guna mengakses layanan backend yang di-deploy di fungsi Cloud Run:

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: {}
...

Untuk mengetahui informasi selengkapnya tentang cara membuat spesifikasi OpenAPI untuk definisi API, lihat Ringkasan OpenAPI.

Langkah berikutnya