Die Discovery API bietet eine Liste von Google APIs zum Abrufen einer maschinenlesbaren Discovery-Dokument-Metadaten für jede API.
Dieses Dokument richtet sich an Entwickler, die Clientbibliotheken, IDE-Plug-ins und andere Tools für die Interaktion mit Google APIs schreiben möchten.
Hintergrund: Discovery-Dienst
Konzepte
Der Google APIs Discovery Service basiert auf zwei grundlegenden Konzepten:
- APIs-Verzeichnis: Eine Liste aller APIs, die vom APIs Discovery Service unterstützt werden. Jeder Verzeichniseintrag enthält Details zu einer unterstützten API, einschließlich Name, Beschreibung und Dokumentationslink. Eine API kann mehrere Verzeichniseinträge haben – einen für jede der unterstützten Versionen.
- Discovery-Dokument: Eine maschinenlesbare Beschreibung einer bestimmten API. Im Discovery-Dokument wird die Oberfläche für eine bestimmte API-Version beschrieben. Das Dokument enthält Details dazu, wie Sie über RESTful-HTTP-Aufrufe auf die verschiedenen Methoden der einzelnen APIs zugreifen können. Ein Discovery-Dokument enthält Beschreibungen der Daten und Methoden im Zusammenhang mit der API sowie Informationen zu verfügbaren OAuth-Bereichen und Beschreibungen von Schemas, Methoden, Parametern und verfügbaren Parameterwerten.
Datenmodell
Eine Ressource ist eine einzelne Datenentität mit einer eindeutigen Kennung. Der Google APIs Discovery Service basiert auf den beiden oben genannten Konzepten.
APIs-Verzeichnisliste: Eine Liste von APIs.
Jeder Verzeichniseintrag enthält ein API-Name/-Versionspaar mit den folgenden Informationen:
- Informationen zur Identifizierung und Beschreibung: Name, Version, Titel und Beschreibung.
- Dokumentationsinformationen: Symbole und ein Dokumentationslink.
- Statusinformationen, einschließlich Statuslabels, und einen Hinweis darauf, ob dies die bevorzugte Version der API ist.
- Discovery-Dokument-Link, der URI des Discovery-Dokuments für diese API (vollständige URL, z.B. https://servicemanagement.googleapis.com/$discovery/rest?version=v1).
Discovery-Dokumentressource: Eine maschinenlesbare Beschreibung einer bestimmten API
Neben den im APIs Directory bereitgestellten Informationen enthält ein Discovery-Dokument auch Folgendes:
- Schemas: eine Liste von API-Ressourcenschemas, die die Daten beschreiben, auf die Sie in den einzelnen APIs Zugriff haben. Die Google APIs Discovery Service-Schemas basieren auf dem JSON-Schema.
- Methoden, einschließlich einer Liste von API-Methoden und der verfügbaren Parameter für jede Methode
- OAuth-Bereiche: Liste der OAuth-Bereiche, die für diese API verfügbar sind.
- Inline-Dokumentation mit kurzen Beschreibungen von Schemas, Methoden, Parametern und verfügbaren Parameterwerten
Die einzelne Verzeichnissammlung ist der konzeptionelle Container der einzelnen APIs-Verzeichnisressource und der Discovery-Dokumentressourcen für jede unterstützte API.
Weitere Informationen zur APIs Directory-Ressource und zur Discovery-Dokumentressource finden Sie in den Dokumenten API verwenden und Referenz.
Operations-Suite
Sie können im Google APIs Discovery Service zwei verschiedene Methoden für Sammlungen und Ressourcen aufrufen, wie in der folgenden Tabelle beschrieben.
| Vorgang | Beschreibung | REST-HTTP-Zuordnungen |
|---|---|---|
| list | Listet alle unterstützten APIs auf. | GET für den Verzeichnisressourcen-URI. |
Anrufstil
REST
Die unterstützten Vorgänge des Google APIs Discovery Service sind direkt dem REST-HTTP-Verb GET zugeordnet, wie unter Vorgänge beschrieben.
Für Google APIs Discovery Service-URIs gilt folgendes Format:
https://discovery.googleapis.com/discovery/v1/apis?parameters
Dabei ist api die ID für eine Discovery-Dokumentressource und version die ID der bestimmten Version der API. _parameters_ ist ein beliebiger Parameter, der auf die Abfrage angewendet werden soll. Weitere Informationen finden Sie in der Referenzdokumentation unter Zusammenfassung der Suchparameter.
Details zu den URIs für die einzelnen unterstützten Vorgänge in der API finden Sie im Dokument Google APIs Discovery Service.
Hier sind einige Beispiele dafür, wie dies im Google APIs Discovery Service funktioniert.
Listen Sie alle von Google APIs Discovery Service unterstützten APIs auf:
GET https://discovery.googleapis.com/discovery/v1/apis
Jetzt im APIs Explorer ausprobieren!
Rufen Sie das Discovery-Dokument für die Google Cloud Service Management API Version 1 ab:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1