Glosarium
Halaman ini menyediakan definisi singkat dan link ke informasi selengkapnya tentang istilah yang digunakan dalam dokumentasi Gateway API.
- API
- Antarmuka REST yang memudahkan satu aplikasi untuk menggunakan kemampuan atau data dari aplikasi lain. Dengan menentukan titik entri yang stabil, sederhana, dan didokumentasikan dengan baik, API memungkinkan developer mengakses dan menggunakan kembali logika aplikasi yang dibuat oleh developer lain dengan mudah.
- Konfigurasi API
- Dibuat saat Anda mengupload definisi API ke Gateway API. Setiap kali Anda mengupload definisi API, Gateway API akan membuat konfigurasi API baru. Artinya, Anda dapat membuat konfigurasi API tetapi tidak dapat mengubahnya di lain waktu. Jika nanti Anda mengedit definisi API, lalu mengupload definisi API yang telah diedit, Anda akan membuat konfigurasi API baru.
- Definisi API
- 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 dari data apa pun yang ditampilkan oleh layanan, mekanisme autentikasi yang digunakan untuk mengontrol akses ke layanan, dan banyak opsi lainnya.
- Kunci API
- Kode yang diteruskan oleh aplikasi klien saat memanggil API. Kunci API mengidentifikasi aplikasi atau project Google Cloud yang melakukan panggilan ke API. Lihat Alasan dan waktu untuk menggunakan kunci API untuk mengetahui informasi selengkapnya tentang cara menggunakan kunci API dengan API Gateway API.
- Auth0
- Layanan yang memungkinkan Anda menentukan cara pengguna melakukan autentikasi ke aplikasi. Lihat Auth0 untuk mengetahui informasi lebih lanjut.
- CORS
- Cross-Origin Resource Sharing (CORS) adalah spesifikasi yang menyediakan cara bagi aplikasi web untuk mengakses resource di server dalam domain lain (secara teknis, di origin lain). Untuk mempelajari CORS lebih lanjut, lihat dokumen web Mozilla Developer Network (MDN) dan Fetch Living Standard.
- Autentikasi Firebase
- 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.
- Gateway
- Proxy berbasis Envoy, berperforma tinggi, dan skalabel 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 ID Google
- Token Web JSON (JWT) yang berisi kolom OpenID Connect yang diperlukan untuk mengidentifikasi akun pengguna atau akun layanan Google, dan yang ditandatangani oleh layanan autentikasi Google,
https://accounts.google.com. - gRPC
- Framework RPC universal open source berperforma tinggi yang dikembangkan oleh Google. Di gRPC, aplikasi klien dapat langsung memanggil metode di aplikasi server di komputer yang berbeda seolah-olah objek tersebut adalah objek lokal. Lihat Ringkasan gRPC untuk mengetahui informasi tentang cara menggunakan gRPC dengan Gateway API dan situs gRPC untuk informasi umum.
- JWT
- Token Web JSON adalah format token akses standar terbuka untuk digunakan di header Otorisasi HTTP dan parameter kueri URI. Lihat Pengantar Token Web JSON untuk mengetahui informasi umum.
- OpenAPI
- Open API Initiative adalah upaya berskala industri untuk menstandarkan 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 informasi selengkapnya.
- Dokumen OpenAPI
- File dalam format YAML atau JSON yang Anda gunakan untuk mendeskripsikan API. File ini juga disebut sebagai definisi API. Saat diupload ke Gateway API, dokumen OpenAPI dikonversi menjadi konfigurasi API.
- Permukaan
- Antarmuka publik API. Platform API terdiri dari metode, serta parameter dan jenis nilai yang ditampilkan yang digunakan dalam metode.