Antarmuka REST yang memudahkan satu aplikasi menggunakan kemampuan atau data dari aplikasi lain. Dengan menentukan titik entri yang stabil, sederhana, dan terdokumentasi dengan baik, API memungkinkan developer mengakses dan menggunakan kembali logika aplikasi yang dibuat oleh developer lain dengan mudah.
Dibuat saat Anda mengupload definisi API ke API Gateway. Setiap kali Anda mengupload definisi API, API Gateway akan membuat konfigurasi API baru. Artinya, Anda dapat membuat konfigurasi API, tetapi tidak dapat mengubahnya nanti. Jika nanti Anda mengedit definisi API, lalu mengupload definisi API yang telah diedit, Anda akan membuat konfigurasi API baru.
Spesifikasi Open API 2.0
atau konfigurasi gRPC yang digunakan untuk membuat konfigurasi API. Definisi API menentukan: URL layanan backend, format data data yang diteruskan pada permintaan, format data data apa pun yang ditampilkan oleh layanan, mekanisme autentikasi yang digunakan untuk mengontrol akses ke layanan, dan banyak lagi opsi.
Kode yang diteruskan oleh aplikasi klien saat memanggil API. Kunci API
mengidentifikasi aplikasi atau Google Cloud project yang melakukan
panggilan ke API. Lihat
Alasan dan waktu menggunakan kunci API
untuk mengetahui informasi selengkapnya tentang cara menggunakan kunci API dengan API API Gateway Anda.
Cross-Origin Resource Sharing (CORS) adalah spesifikasi yang menyediakan cara bagi aplikasi web untuk mengakses resource di server di domain lain (secara teknis, di origin lain). Untuk mempelajari CORS lebih lanjut, lihat dokumen web Mozilla Developer Network (MDN) dan Fetch Living Standard.
Layanan autentikasi Google yang mendukung login pengguna akhir untuk aplikasi
klien menggunakan kredensial dari penyedia identitas gabungan populer
seperti Google, Facebook, atau Twitter. Lihat
Autentikasi Firebase
untuk mengetahui informasi selengkapnya.
Proxy berbasis Envoy yang skalabel dan berperforma tinggi yang menghosting konfigurasi API yang di-deploy. Membuat gateway akan membuat URL eksternal yang digunakan klien API Anda untuk mengakses API. Gateway hanya menghosting satu konfigurasi API. Anda tidak dapat men-deploy beberapa konfigurasi API ke gateway yang sama.
Token Web JSON (JWT) yang berisi kolom OpenID Connect yang diperlukan untuk mengidentifikasi akun pengguna atau akun layanan Google, dan ditandatangani oleh layanan autentikasi Google, https://accounts.google.com.
Framework RPC universal open source berperforma tinggi yang dikembangkan oleh Google.
Di gRPC, aplikasi klien dapat langsung memanggil metode pada aplikasi server
di komputer lain seolah-olah itu adalah objek lokal. Lihat
Ringkasan gRPC
untuk mengetahui informasi tentang cara menggunakan gRPC dengan API Gateway dan situs
gRPC
untuk mengetahui informasi umum.
Token Web JSON adalah format token akses standar terbuka untuk digunakan dalam header
Otorisasi HTTP dan parameter kueri URI.
Lihat Pengantar Token Web JSON untuk informasi umum.
Open API Initiative adalah upaya seluruh industri untuk
menstandardisasi deskripsi REST API. API yang dijelaskan dengan
Spesifikasi OpenAPI (sebelumnya
Spesifikasi Swagger) dapat didukung dengan alat
umum yang membuat dokumentasi, mengotomatiskan pengujian, dan membuat kode untuk klien
dan server. Lihat Ringkasan OpenAPI
untuk mengetahui informasi selengkapnya.
File dalam format YAML atau JSON yang Anda gunakan untuk mendeskripsikan API.
File ini juga disebut sebagai definisi API.
Saat diupload ke API Gateway, dokumen OpenAPI akan dikonversi menjadi konfigurasi API.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-03 UTC."],[[["\u003cp\u003eThis page provides definitions and links to further information for terms used within the API Gateway documentation.\u003c/p\u003e\n"],["\u003cp\u003eAPI definitions, created using OpenAPI or gRPC configurations, specify backend service URLs, data formats, and authentication mechanisms, among other options.\u003c/p\u003e\n"],["\u003cp\u003eAn API config is created each time an API definition is uploaded to API Gateway and is not modifiable, requiring a new upload for any edits.\u003c/p\u003e\n"],["\u003cp\u003eGateways, which are Envoy-based proxies, host a deployed API config and provide the external URL that clients use to access the API, with each gateway supporting only one API config.\u003c/p\u003e\n"],["\u003cp\u003eAPI keys are codes used by client applications to identify themselves or their Google Cloud project when calling an API.\u003c/p\u003e\n"]]],[],null,["# Glossary\n========\n\nThis page provides brief definitions and links to more information of terms\nthat are used in the API Gateway documentation.\n\nAPI\n: A REST interface that makes it easy for one application to consume capabilities or data from another application. By defining stable, simple, and well-documented entry points, APIs enable developers to easily access and reuse application logic built by other developers.\n\nAPI config\n: Created when you upload an [API definition](#api_definition) to API Gateway. Each time you upload an API definition, API Gateway creates a new API config. That is, you can create an API config but you cannot later modify it. If you later edit the API definition, and then upload the edited API definition, you create a new API config.\n\nAPI definition\n: An [Open API 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) spec\n or [gRPC](http://www.grpc.io) configuration used to create an [API config](#api_config). An API definition specifies: the URL of the backend service, the data format of data passed on a request, the data format of any data returned by the service, the authentication mechanism used to control access to the service, and many more options.\n\nAPI key\n: A code passed in by a client application when it calls an API. API\n keys identify the application or the Google Cloud project making\n the call to the API. See\n [Why and when to use API keys](/endpoints/docs/openapi/when-why-api-key)\n for more information on using an API key with your API Gateway API.\n\nAuth0\n: A service that lets you define how users authenticate to applications. See\n [Auth0](https://auth0.com) for more information.\n\nCORS\n: Cross-Origin Resource Sharing (CORS) is a specification that provides a way\n for web applications to access resources on a server in another domain\n (technically, in another origin). To learn more about CORS, see the\n [Mozilla Developer Network (MDN) web docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\n and the [Fetch Living Standard](https://fetch.spec.whatwg.org/).\n\nFirebase authentication\n: Google's authentication service that supports end user sign-in for client\n applications by using credentials from popular federated identity providers\n such as Google, Facebook, or Twitter. See\n [Firebase authentication](https://firebase.google.com/docs/auth/)\n for more information.\n\nGateway\n: An [Envoy](https://www.envoyproxy.io/docs/envoy/latest/)-based, high-performance, scalable proxy that hosts the deployed [API config](#api_config). Creating a gateway creates the external facing URL that your API clients use to access the API. A gateway only host a single API config. You cannot deploy multiple API configs to the same gateway.\n\nGoogle ID token\n: A JSON Web Token (JWT) that contains the\n [OpenID Connect](https://developers.google.com/identity/protocols/OpenIDConnect)\n fields needed to identify a Google user account or service account, and that\n is signed by Google's authentication service, `https://accounts.google.com`.\n\ngRPC\n: A high performance, open source universal RPC framework developed by Google.\n In gRPC, a client application can directly call methods on a server application\n on a different machine as if it was a local object. See\n [gRPC Overview](/api-gateway/docs/grpc-overview)\n for information on using gRPC with API Gateway and the\n [gRPC](http://www.grpc.io)\n website for general information.\n\nJWT\n: JSON Web Token is an open standard access token format for use in HTTP\n Authorization headers and URI query parameters.\n See [Introduction to JSON Web Tokens](https://jwt.io/introduction/)\n for general information.\n\nOpenAPI\n: The [Open API Initiative](http://openapis.org) is an industry-wide effort to\n standardize the description of REST APIs. APIs that are described with the\n [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly\n the [Swagger Specification](http://swagger.io)) can be supported with common\n tools that create documentation, automate testing, and generate code for clients\n and servers. See [OpenAPI overview](/api-gateway/docs/openapi-overview)\n for more information.\n\nOpenAPI document\n: A file in either YAML or JSON format that you use to describe your API.\n This file is also referred to as an [API definition](#api_definition).\n When uploaded to API Gateway, the OpenAPI document is converted to an [API config](#api_config).\n\nSurface\n: The public interface of an [API](#api_def). An API's surface consists of the methods\n as well as the parameters and return types used in the methods."]]
