Interfejs Discovery API udostępnia listę interfejsów API Google, z której można pobrać czytelne dla komputera metadane w postaci „dokumentu opisującego” dla każdego interfejsu API.
Ten dokument jest przeznaczony dla programistów, którzy chcą pisać biblioteki klienta, wtyczki IDE i inne narzędzia do interakcji z interfejsami API Google.
Informacje o usłudze wykrywania
Pojęcia
Usługa Discovery interfejsów API Google opiera się na 2 podstawowych koncepcjach:
- Katalog interfejsów API: lista wszystkich interfejsów API obsługiwanych przez usługę wykrywania interfejsów API. Każdy wpis w katalogu zawiera szczegóły obsługiwanego interfejsu API, w tym jego nazwę, krótki opis działania oraz link do dokumentacji. Interfejs API może mieć wiele wpisów w katalogu, po jednym dla każdej obsługiwanej wersji.
- Dokument opisujący: czytelny dla komputera opis konkretnego interfejsu API. Dokument opisujący opisuje interfejs dla konkretnej wersji interfejsu API. Dokument zawiera szczegółowe informacje o tym, jak uzyskać dostęp do różnych metod każdego interfejsu API za pomocą wywołań HTTP RESTful. Dokument Discovery zawiera opisy danych i metod powiązanych z interfejsem API, a także informacje o dostępnych zakresach OAuth oraz opisy schematów, metod, parametrów i dostępnych wartości parametrów.
Model danych
Zasób to pojedynczy obiekt danych z unikalnym identyfikatorem. Usługa Discovery API Google działa na 2 rodzajach zasobów, które są oparte na powyższych koncepcjach.
Lista interfejsów API: lista interfejsów API
Każdy wpis w katalogu zawiera parę nazwa/wersja interfejsu API z tymi informacjami:
- Informacje identyfikacyjne i opisowe: nazwa, wersja, tytuł i opis.
- Informacje o dokumentacji: ikony i link do dokumentacji.
- Informacje o stanie, w tym etykiety stanu i wskazanie, czy jest to preferowana wersja interfejsu API.
-
Link do dokumentu wykrywania, identyfikator URI dokumentu wykrywania dla tego interfejsu API (podany jako pełny adres URL, np.
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Zasób dokumentu opisującego: czytelny dla komputera opis konkretnego interfejsu API.
Oprócz informacji podanych w katalogu interfejsów API dokument Discovery zawiera też:
- Schematy, czyli lista schematów zasobów interfejsu API, które opisują dane, do których masz dostęp w każdym interfejsie API. Schematy usługi Google APIs Discovery Service są oparte na schemacie JSON.
- Metody, w tym listę metod interfejsu API i dostępnych parametrów dla każdej metody.
- Zakresy OAuth, które identyfikują listę zakresów OAuth dostępnych w tym interfejsie API.
- Dokumentacja wbudowana, która zawiera krótkie opisy schematów, metod, parametrów i dostępnych wartości parametrów.
Pojedyncza kolekcja katalogów to koncepcyjny kontener pojedynczego zasobu interfejsów API Directory oraz zasobów dokumentu opisującego dla każdego obsługiwanego interfejsu API.
Operacje
W usłudze Discovery API Google możesz wywoływać 2 różne metody w kolekcjach i zasobach, jak opisano w tabeli poniżej.
| Operacja | Opis | Mapowania HTTP REST |
|---|---|---|
| list | Wyświetla listę wszystkich obsługiwanych interfejsów API. | GET w identyfikatorze URI zasobu Katalog. |
Styl połączenia
REST
Obsługiwane operacje usługi Discovery API Google są bezpośrednio powiązane z czasownikiem REST HTTP GET, jak opisano w sekcji Operacje.
Adresy URI usługi Discovery API Google mają ten format:
https://API/$discovery/rest?version=VERSION
gdzie API to identyfikator zasobu dokumentu opisującego, a VERSION to identyfikator konkretnej wersji interfejsu API.
Oto kilka przykładów, jak to działa w usłudze Discovery interfejsów API Google.
Wyświetl listę wszystkich interfejsów API obsługiwanych przez usługę Discovery interfejsów API Google:
GET https://discovery.googleapis.com/discovery/v1/apis
Wypróbuj teraz w narzędziu APIs Explorer
Pobierz dokument opisujący interfejs Service Usage API w wersji 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1