Discovery API menyediakan daftar Google API untuk mengambil metadata "Dokumen penemuan" yang dapat dibaca mesin untuk setiap API.
Dokumen ini ditujukan untuk developer yang ingin menulis library klien, plugin IDE, dan alat lainnya untuk berinteraksi dengan Google API.
Latar Belakang Layanan Penemuan
Konsep
Layanan Discovery Google API dibuat berdasarkan dua konsep dasar:
- Direktori API: Daftar semua API yang didukung oleh Layanan Penemuan API. Setiap entri direktori menampilkan detail tentang API yang didukung, termasuk nama, deskripsi singkat tentang fungsi API tersebut, dan link dokumentasi. API dapat memiliki beberapa entri Direktori, satu entri untuk setiap versi yang didukung.
- Dokumen discovery: Deskripsi API yang dapat dibaca mesin. Dokumen Discovery menjelaskan platform versi API tertentu. Dokumen ini menyediakan detail tentang cara mengakses berbagai metode dari setiap API melalui panggilan HTTP RESTful. Dokumen Discovery menyertakan deskripsi data dan metode yang terkait dengan API, serta informasi tentang cakupan OAuth yang tersedia, dan deskripsi skema, metode, parameter, serta nilai parameter yang tersedia.
Model data
Resource adalah entity data individual dengan ID unik. Layanan Penemuan Google API beroperasi pada dua jenis sumber daya, berdasarkan konsep di atas.
Daftar Direktori API: Daftar API
Setiap entri direktori berisi pasangan name/version API dengan informasi berikut:
- Informasi identifikasi dan deskripsi,: nama, versi, judul, dan deskripsi.
- Informasi dokumentasi: ikon dan link dokumentasi.
- Informasi status, termasuk label status, dan indikasi apakah versi ini merupakan API pilihan atau tidak.
- Link dokumen penemuan, URI dokumen penemuan untuk API ini (diberikan sebagai URL lengkap, mis. https://servicemanagement.googleapis.com/$discovery/rest?version=v1).
Resource Dokumen Discovery: Deskripsi API yang dapat dibaca mesin
Selain informasi yang disediakan dalam Direktori API, dokumen Discovery juga menyertakan:
- Skema, yang merupakan daftar skema resource API yang menjelaskan data yang dapat Anda akses di setiap API; skema Layanan Penemuan Google API didasarkan pada Skema JSON.
- Metode, termasuk daftar metode API dan parameter yang tersedia untuk setiap metode.
- Cakupan OAuth, yang mengidentifikasi daftar cakupan OAuth yang tersedia untuk API ini.
- Dokumentasi inline, yang memberikan deskripsi singkat tentang skema, metode, parameter, dan nilai parameter yang tersedia.
Koleksi Direktori tunggal adalah penampung konseptual untuk resource Resource API tunggal, dan resource Dokumen Discovery untuk setiap API yang didukung.
Detail selengkapnya tentang resource Direktori API dan resource Dokumen Discovery disediakan dalam dokumen Menggunakan API dan Referensi.
Operasi
Anda dapat memanggil dua metode yang berbeda pada koleksi dan resource di Google API Discovery Service, seperti yang dijelaskan dalam tabel berikut.
| Operasi | Deskripsi | Pemetaan HTTP REST |
|---|---|---|
| list | Mencantumkan semua API yang didukung. | GET pada URI resource Direktori. |
Gaya panggilan
REST
Operasi Layanan Penemuan Google API yang didukung dipetakan langsung ke kata kerja REST HTTP GET, seperti yang dijelaskan dalam Operasi.
Format spesifik untuk URI Layanan Penemuan Google API adalah:
https://discovery.googleapis.com/discovery/v1/apis?parameters
dengan api adalah ID untuk resource Dokumen Discovery, dan version adalah ID versi API tertentu, dan _parameters_ adalah parameter apa pun yang akan diterapkan ke kueri. Untuk mengetahui detailnya, lihat Ringkasan parameter kueri di dokumentasi referensi
Detail tentang kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung di API diringkas dalam dokumen Referensi Layanan Penemuan Google API.
Berikut adalah beberapa contoh cara kerjanya di Layanan Discovery Google API.
Cantumkan semua API yang didukung Layanan Discovery Google API:
GET https://discovery.googleapis.com/discovery/v1/apis
Coba sekarang di APIs Explorer!
Dapatkan dokumen Discovery untuk Google Cloud Service Management API, versi 1:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1