Discovery API, her API'nin makine tarafından okunabilen "Keşif dokümanı" meta verilerini almak için kullanılan Google API'lerinin listesini sunar.
Bu doküman istemci kitaplıkları, IDE eklentileri ve Google API'leri ile etkileşimde bulunmak için kullanılan 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 kavrama dayanmaktadır:
- API'ler Dizini: API Discovery Hizmeti tarafından desteklenen tüm API'lerin listesi. Her dizin girişinde, ad, işlevin kısa bir açıklaması ve dokümantasyon bağlantısı da dahil olmak üzere, desteklenen bir API hakkında ayrıntılar gösterilir. Bir API'de, desteklenen her sürümü için bir tane olmak üzere birden çok Dizin girişi bulunabilir.
- Keşif dokümanı: Belirli bir API'nin makine tarafından okunabilen açıklaması. Keşif dokümanı, bir API'nin belirli bir sürümü için yüzeyi açıklar. Dokümanda, RESTful HTTP çağrılarıyla her bir API'nın çeşitli yöntemlerine nasıl erişileceği hakkında ayrıntılar yer almaktadır. Bir keşif dokümanı, API ile ilişkili verilerin ve yöntemlerin açıklamasının yanı sıra, mevcut OAuth kapsamlarıyla ilgili bilgilerin yanı sıra şema, yöntem, parametre 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 varlığıdır. Google API Discovery Hizmeti, yukarıdaki kavramlara bağlı olarak iki tür kaynak üzerinde çalışır.
API'ler Dizin Listesi: API'lerin listesi
Her dizin girişi, aşağıdaki bilgileri içeren bir API adı/sürümü çifti içerir:
- Kimlik ve açıklama bilgileri: ad, sürüm, başlık ve açıklama.
- Belge bilgileri: simgeler ve doküman bağlantısı.
- Durum etiketleri ve bunun API'nin tercih edilen sürümü olup olmadığına dair bir işaret de dahil olmak üzere durum bilgileri.
- Keşif dokümanı bağlantısı, bu API için keşif dokümanının URI'sı (tam URL olarak verilir, ör. https://servicemanagement.googleapis.com/$discovery/rest?version=v1).
Keşif Dokümanı kaynağı: Belirli bir API'nin makine tarafından okunabilir açıklaması
Bir Discovery dokümanı, API Dizini'nde sağlanan bilgilere ek olarak şunları da içerir:
- Şemalar, her API'de erişiminiz olan verileri açıklayan API kaynağı şemalarının listesidir. Google API'leri Keşif Hizmeti şemaları JSON Şeması'nı temel alır.
- Yöntemler (API yöntemlerinin listesi ve her yöntem için kullanılabilir parametreler dahil).
- Bu API için kullanılabilen OAuth kapsamlarının listesini tanımlayan OAuth kapsamları.
- Şemalar, yöntemler, parametreler ve kullanılabilir parametre değerleriyle ilgili kısa açıklamalar sağlayan satır içi dokümanlar.
Tek Dizinli Koleksiyon, tek API'ler Dizin kaynağının ve desteklenen her API'nin Keşif Dokümanı kaynaklarıdır.
API'yi kullanma ve Referans dokümanlarında API'ler Dizin kaynağı ve Keşif Dokümanı kaynağı hakkında daha ayrıntılı bilgi bulabilirsiniz.
İşlemler
Aşağıdaki tabloda açıklandığı gibi, Google API Discovery Hizmeti'ndeki koleksiyon 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 Discovery Hizmeti işlemleri, İşlemler bölümünde açıklandığı gibi doğrudan REST HTTP GET fiiliyle eşlenir.
Google API Discovery Hizmeti URI'leri için belirli biçim şöyledir:
https://discovery.googleapis.com/discovery/v1/apis?parameters
Burada api, bir Keşif Dokümanı kaynağının tanımlayıcısıdır. version ise API'nin belirli sürümünün tanımlayıcısıdır. _parameters_ ise sorguya uygulanacak tüm parametrelerdir. Ayrıntılar için referans dokümanlarındaki Sorgu parametresi özeti bölümüne bakın
API'de desteklenen her işlem için kullanılan URI'lerin tümüyle ilgili ayrıntılar Google API'leri Keşif Hizmeti Referansı dokümanında özetlenmiştir.
Aşağıda, Google API Discovery Hizmeti'nde nasıl işlediğine dair birkaç örnek verilmiştir.
Google API Discovery Hizmeti'nin desteklediği tüm API'leri listeleyin:
GET https://discovery.googleapis.com/discovery/v1/apis
Şimdi API Gezgini'nde deneyin!
Google Cloud Service Management API için sürüm belgesini alın, sürüm 1:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1