Discovery API, her API için makine tarafından okunabilir bir "Discovery belgesi" meta verilerini almak üzere Google API'lerinin bir listesini sağlar.
Bu belge, Google API'leriyle etkileşim kurmak için istemci kitaplıkları, IDE eklentileri ve diğer araçları yazmak isteyen geliştiriciler için hazırlanmıştır.
Keşif Hizmeti Arka Planı
Kavramlar
Google API'leri Keşif Hizmeti iki temel kavram üzerine kurulmuştur:
- API Dizini: API'ler Keşif Hizmeti tarafından desteklenen tüm API'lerin listesi. Her dizin girişi, desteklenen bir API ile ilgili ayrıntıları gösterir. Bu ayrıntılar arasında API'nin adı, ne yaptığına dair kısa bir açıklama ve doküman bağlantısı yer alır. Bir API'nin, desteklenen her sürümü için bir tane olmak üzere birden fazla dizin girişi olabilir.
- Keşif belgesi: Belirli bir API'nin makine tarafından okunabilir açıklaması. Keşif belgesi, API'nin belirli bir sürümünün yüzeyini açıklar. Bu belgede, RESTful HTTP çağrıları aracılığıyla her API'nin çeşitli yöntemlerine nasıl erişileceği hakkında ayrıntılı bilgi verilmektedir. Bir Discovery belgesi, API ile ilişkili verilerin ve yöntemlerin açıklamalarının yanı sıra kullanılabilir OAuth kapsamları hakkında bilgiler ve şemaların, yöntemlerin, parametrelerin ve kullanılabilir parametre değerlerinin açıklamalarını içerir.
Veri modeli
Kaynak, benzersiz tanımlayıcısı olan bağımsız bir veri öğesidir. Google API'leri Keşif Hizmeti, yukarıdaki kavramlara dayalı olarak iki tür kaynak üzerinde çalışır.
API Dizini Listesi: API listesi
Her dizin girişi, aşağıdaki bilgileri içeren bir API adı/sürümü çifti içerir:
- Tanımlama ve açıklama bilgileri: ad, sürüm, başlık ve açıklama.
- Belge bilgileri: Simgeler ve belge bağlantısı.
- Durum etiketleri de dahil olmak üzere durum bilgileri ve API'nin tercih edilen sürüm olup olmadığına dair bir gösterge.
-
Keşif dokümanı bağlantısı: Bu API'nin keşif dokümanının URI'si
(tam URL olarak verilir, örneğin,
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Discovery Document kaynağı: Belirli bir API'nin makine tarafından okunabilir açıklaması
API Dizini'nde verilen bilgilere ek olarak, bir Keşif belgesi şunları da içerir:
- Şemalar: Her API'de erişebildiğiniz verileri açıklayan API kaynak şemalarının listesidir. Google API'leri Keşif Hizmeti şemaları JSON Şeması'na dayanır.
- API yöntemlerinin ve her yöntem için kullanılabilen parametrelerin listesi de dahil olmak üzere Yöntemler.
- Bu API için kullanılabilen OAuth kapsamlarının listesini tanımlayan OAuth kapsamları.
- Şemalar, yöntemler, parametreler ve kullanılabilir parametre değerleri hakkında kısa açıklamalar sağlayan satır içi dokümanlar.
Tek bir Directory Collection, tek bir API Directory kaynağının ve desteklenen her API'nin Discovery Document kaynaklarının kavramsal kapsayıcısıdır.
İşlemler
Aşağıdaki tabloda açıklandığı gibi, Google API'leri Discovery Hizmeti'ndeki koleksiyonlarda ve kaynaklarda iki farklı yöntem çağırabilirsiniz.
| İşlem | Açıklama | REST HTTP eşlemeleri |
|---|---|---|
| list | Desteklenen tüm API'leri listeler. | Dizin kaynağı URI'sinde GET |
Arama stili
REST
Desteklenen Google API'leri Discovery Service işlemleri, İşlemler bölümünde açıklandığı gibi doğrudan REST HTTP
GET fiiline eşlenir.
Google API'leri Discovery Hizmeti URI'lerinin biçimi şöyledir:
https://API/$discovery/rest?version=VERSION
burada API, bir Discovery Document kaynağının tanımlayıcısıdır ve VERSION, API'nin belirli sürümünün tanımlayıcısıdır.
Google API'leri Keşif Hizmeti'nde bu özelliğin nasıl çalıştığına dair birkaç örneği aşağıda bulabilirsiniz.
Google API'leri Keşif Hizmeti tarafından desteklenen tüm API'leri listeleyin:
GET https://discovery.googleapis.com/discovery/v1/apis
Hemen API Gezgini'nde deneyin.
Service Usage API, sürüm 1 için Discovery belgesini alın:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1