Dokument opisujący: lista

Pobierz listę interfejsów API obsługiwanych w tym punkcie końcowym.

Metoda discovery.apis.list zwraca listę wszystkich interfejsów API obsługiwanych przez usługę Google APIs Discovery Service. Dane każdego wpisu są podzbiorem dokumentu Discovery Document dla danego interfejsu API, a lista zawiera katalog obsługiwanych interfejsów API. Jeśli konkretny interfejs API ma kilka wersji, każda z nich ma własny wpis na liście.

Żądanie

Żądanie HTTP

GET https://discovery.googleapis.com/discovery/v1/apis

Parametry

Nazwa parametru Wartość Opis
Parametry opcjonalne
name string Uwzględniaj tylko interfejsy API o podanej nazwie.
preferred boolean Zwraca tylko preferowaną wersję interfejsu API.  Domyślnie „false”.

Treść żądania

Nie podawaj treści żądania w przypadku tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w poniższym formacie:

{
  "kind": "discovery#directoryList",
  "discoveryVersion": "v1",
  "items": [
    {
      "kind": "discovery#directoryItem",
      "id": string,
      "name": string,
      "version": string,
      "title": string,
      "description": string,
      "discoveryRestUrl": string,
      "discoveryLink": string,
      "icons": {
        "x16": string,
        "x32": string
      },
      "documentationLink": string,
      "labels": [
        string
      ],
      "preferred": boolean
    }
  ]
}
Nazwa właściwości Wartość Opis
kind string Ustalony ciąg znaków discovery#directoryList
discoveryVersion string Wskaż wersję interfejsu Discovery API użytego do wygenerowania tego dokumentu.
items[] list poszczególne wpisy w katalogu. Po jednym wpisie dla każdej pary interfejs API/wersja.
items[].kind string Rodzaj tej odpowiedzi.
items[].id string Identyfikator tego interfejsu API.
items[].name string Nazwa interfejsu API.
items[].version string Wersja interfejsu API.
items[].title string Nazwa tego interfejsu API.
items[].description string Opis tego interfejsu API.
items[].discoveryRestUrl string Adres URL dokumentu REST opisującego.
items[].icons object Linki do ikon o rozmiarach 16 x 16 i 32 x 32 pikseli reprezentujących interfejs API.
items[].icons.x16 string Adres URL ikony 16 x 16.
items[].icons.x32 string Adres URL ikony o wymiarach 32 x 32.
items[].labels[] list Etykiety stanu tego interfejsu API, np. limited_availability lub deprecated.
items[].preferred boolean true jeśli ta wersja jest preferowaną wersją do użycia.