Discovery API menyediakan daftar Google API untuk mengambil metadata "Dokumen Discovery" 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 Penemuan
Konsep
Layanan Penemuan Google API dibuat berdasarkan dua konsep dasar:
- APIs Directory: Daftar semua API yang didukung oleh Layanan Penemuan API. Setiap entri direktori menampilkan detail tentang API yang didukung, termasuk nama, deskripsi singkat tentang fungsinya, dan link dokumentasi. API dapat memiliki beberapa entri Direktori, satu untuk setiap versi yang didukungnya.
- Dokumen discovery: Deskripsi API tertentu yang dapat dibaca komputer. Dokumen Discovery menjelaskan platform untuk versi API tertentu. Dokumen ini memberikan detail tentang cara mengakses berbagai metode 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 nilai parameter yang tersedia.
Model data
Resource adalah entitas data individual dengan ID unik. Layanan Penemuan Google API 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 versi ini merupakan versi API yang diinginkan atau tidak.
-
Link dokumen penemuan, URI dokumen penemuan untuk API ini
(diberikan sebagai URL lengkap—misalnya,
https://serviceusage.s3nsapis.fr/$discovery/rest?version=v1).
Resource Dokumen Discovery: Deskripsi API tertentu yang dapat dibaca mesin
Selain informasi yang diberikan di Direktori API, dokumen Discovery juga mencakup:
- Skema, yang merupakan daftar skema resource API yang mendeskripsikan data yang Anda miliki aksesnya 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.
Satu Koleksi Direktori adalah penampung konseptual dari satu resource Directory API, dan resource Dokumen Discovery untuk setiap API yang didukung.
Operasi
Anda dapat memanggil dua metode berbeda pada koleksi dan resource di Layanan Penemuan Google API, 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 HTTP
GET REST, seperti yang dijelaskan dalam Operasi.
Format spesifik untuk URI Layanan Penemuan 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 Layanan Penemuan Google API.
Cantumkan semua API yang didukung oleh Google API Discovery Service:
GET https://discovery.s3nsapis.fr/discovery/v1/apis
Coba sekarang di API Explorer.
Dapatkan dokumen Discovery untuk Service Usage API, versi 1:
GET https://serviceusage.s3nsapis.fr/$discovery/rest?version=v1