Interfejs Discovery API zawiera listę interfejsów API Google, które można pobrać w czytelnych dla komputera &metadanych dokumentu opisującego.
Ten dokument jest przeznaczony dla programistów, którzy chcą tworzyć biblioteki klienta, wtyczki IDE i inne narzędzia do korzystania z interfejsów API Google.
Tło usługi wykrywania
Pojęcia
Usługa wykrywania interfejsów API Google opiera się na 2 podstawowych pojęciach:
- 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ółowe informacje na temat obsługiwanego interfejsu API, w tym nazwę, krótki opis jego działania i link do dokumentacji. Interfejs API może mieć wiele wpisów w katalogu, po jednym dla każdej z obsługiwanych wersji.
- Dokument Discovery: zrozumiały dla komputera opis konkretnego interfejsu API. Dokument Discovery opisuje interfejs określonej wersji interfejsu API. Dokument zawiera informacje o dostępie do różnych metod każdego z interfejsów API za pomocą wywołań RESTowych HTTP. Dokument Discovery zawiera opisy danych i metod powiązanych z interfejsem API, a także informacje o dostępnych zakresach protokołu OAuth oraz opisy schematów, metod, parametrów i dostępnych wartości parametrów.
Model danych
Zasób to pojedynczy element danych z unikalnym identyfikatorem. Usługa wykrywania interfejsów API Google działa na podstawie 2 typów zasobów na podstawie powyższych koncepcji.
Lista interfejsów API: lista interfejsów API.
Każda pozycja w katalogu zawiera parę nazwę/wersję interfejsu API z tymi informacjami:
- Informacje o identyfikacji i opisie: nazwa, wersja, tytuł i opis.
- Informacje o dokumentacji: ikony i link do dokumentacji.
- Informacje o stanie, w tym etykiety stanu oraz określenie, czy jest to preferowana wersja interfejsu API.
- Link do dokumentu opisującego, identyfikator URI dokumentu opisującego ten interfejs API (podany jako pełny adres URL, np. https://servicemanagement.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 opisujących dane, do których masz dostęp w poszczególnych interfejsach API. Schematy usługi wykrywania interfejsów API Google oparte na schemacie JSON.
- Metody, w tym listę metod interfejsu API oraz dostępnych parametrów dla każdej z nich.
- Zakresy OAuth, które identyfikują listę zakresów OAuth dostępnych w przypadku danego interfejsu API.
- Dokumentacja wewnętrzna – krótkie opisy schematów, metod, parametrów i ich wartości.
Zbiór kolekcji to koncepcyjny kontener pojedynczego zasobu katalogu API i zasobów dokumentu Discovery dla każdego obsługiwanego interfejsu API.
Więcej informacji o zasobach katalogu interfejsów API i zasobie dokumentu opisującego znajdziesz w dokumentach Korzystanie z interfejsu API i Informacje.
Operacje
W usłudze Discovery API możesz wywoływać 2 metody na potrzeby kolekcji i zasobów, zgodnie z opisem w tabeli poniżej.
| Operacja | Opis | Mapowanie HTTP REST |
|---|---|---|
| list | Wyświetla listę wszystkich obsługiwanych interfejsów API. | GET w identyfikatorze URI zasobu katalogu. |
Styl rozmów
REST
Obsługiwane operacje usługi wykrywania interfejsów API Google mapują się bezpośrednio na czasownik HTTP GET REST zgodnie z opisem w sekcji Operacje.
Identyfikator konkretnego formatu identyfikatorów URI usługi wykrywania interfejsów API Google to:
https://discovery.googleapis.com/discovery/v1/apis?parameters
gdzie api to identyfikator zasobu dokumentu Discovery, version to identyfikator konkretnej wersji interfejsu API, a _parameters_ to wszystkie parametry, które mają być stosowane do zapytania. Więcej informacji znajdziesz w Podsumowaniu parametrów zapytania w dokumentacji
Szczegółowe informacje o pełnym zestawie identyfikatorów URI używanych w poszczególnych obsługiwanych operacjach w interfejsie API znajdziesz w dokumentacji usługi wykrywania interfejsów API Google.
Oto kilka przykładów działania usługi wykrywania interfejsów API Google.
Wypisz wszystkie interfejsy API obsługiwane przez usługę Google APIs Discovery Service:
GET https://discovery.googleapis.com/discovery/v1/apis
Wypróbuj teraz w Eksploratorze interfejsów API
Pobieranie dokumentu wykrywania interfejsu API zarządzania usługami Google Cloud w wersji 1:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1