Discovery API menyediakan daftar Google API untuk mengambil metadata "Dokumen penemuan" yang dapat dibaca mesin untuk setiap API.
Dokumen ini ditujukan bagi developer yang ingin menulis library klien, plugin IDE, dan alat lainnya untuk berinteraksi dengan Google API.
Latar Belakang Layanan Discovery
Konsep
Layanan Penemuan Google API dibuat berdasarkan dua konsep dasar:
- Direktori API: Daftar semua API yang didukung oleh API Discovery Service. Setiap entri direktori menunjukkan detail tentang API yang didukung, termasuk nama-nya, deskripsi singkat tentang apa yang dilakukannya, dan link dokumentasi. Sebuah API dapat memiliki beberapa entri Direktori, satu untuk setiap versi yang didukung.
- Dokumen penemuan: Deskripsi API tertentu yang dapat dibaca mesin. Dokumen Discovery menjelaskan platform untuk versi API tertentu. Dokumen ini memberikan 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, dan parameter value yang tersedia.
Model data
Resource adalah entity data individual dengan ID unik. Google API Discovery Service beroperasi pada dua jenis resource, 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 ini versi API yang dipilih atau bukan.
-
Link dokumen discovery, URI dokumen discovery untuk API ini
(diberikan dalam URL lengkap—misalnya,
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Resource Dokumen Discovery: Deskripsi API tertentu yang dapat dibaca mesin
Selain informasi yang diberikan dalam Direktori API, dokumen Discovery juga mencakup:
- Skema, yang merupakan daftar skema resource API yang mendeskripsikan data yang dapat Anda akses di setiap API. Skema Google API Discovery Service didasarkan pada Skema JSON.
- Methods, 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.
Satu Koleksi Direktori adalah container konseptual dari satu resource Direktori API, dan resource Dokumen Discovery untuk setiap API yang didukung.
Operasi
Anda dapat memanggil dua metode 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 di URI resource Direktori. |
Gaya panggilan
REST
Operasi Google API Discovery Service yang didukung dipetakan langsung ke kata kerja GET HTTP
REST, seperti yang dijelaskan dalam Operations.
Format spesifik untuk URI Layanan Discovery Google API adalah:
https://API/$discovery/rest?version=VERSION
dengan API adalah ID untuk resource Dokumen Discovery, dan VERSION adalah ID versi API tertentu.
Berikut beberapa contoh cara kerjanya di Google API Discovery Service.
Menampilkan daftar semua API yang didukung Google API Discovery Service:
GET https://discovery.googleapis.com/discovery/v1/apis
Coba sekarang di APIs Explorer.
Dapatkan dokumen Discovery untuk Service Usage API, versi 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1