Die Admin API-Vorgänge können direkt REST HTTP-Verben zugeordnet werden. Sie verwenden somit zum Abrufen und Bearbeiten Ihrer Ressourcen HTTP-Standardmethoden.
Für Admin API-URIs gibt es folgende Sonderformate:
https://appengine.googleapis.com/v1/resourcePath?parameters
Wenn Sie beispielsweise alle Details zur Version my-v1 im Dienst my-
frontend der Anwendung im Projekt my-app auflisten möchten, können Sie die HTTP-Anfrage mit dem Parameter ?view=FULL senden:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Im Referenzdokument zur App Engine Admin API finden Sie die vollständige Liste der URIs zu allen in der API unterstützten Vorgängen.
Grundlagen
Sie sind noch nicht mit REST APIs vertraut? Die folgenden Ressourcen erleichtern Ihnen den Einstieg.
Grundlagen von REST
Es gibt zwei Möglichkeiten, die API aufzurufen:
- HTTP-Anfragen senden und die Antworten parsen
- Clientbibliotheken verwenden
Wenn Sie keine Clientbibliotheken verwenden möchten, benötigen Sie grundlegende REST-Kenntnisse.
REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.
REST steht für "Representational State Transfer". Im Kontext der Google APIs ist damit die Verwendung von HTTP-Verben gemeint, um Darstellungen von Daten, die bei Google gespeichert sind, abzufragen und zu bearbeiten.
In einem als "RESTful" bezeichneten System werden Ressourcen in einem Datenspeicher abgelegt; ein Client sendet eine Aufforderung, der Server möge eine bestimmte Aktion ausführen (z. B. eine Ressource erstellen, abfragen, aktualisieren oder löschen), und der Server führt die Aktion aus und sendet eine Antwort, oft in Form einer Darstellung der angegebenen Ressource.
In Googles RESTful APIs spezifiziert der Client eine Aktion mit einem HTTP-Verb wie POST, GET, PUT oder DELETE. Eine Ressource wird anhand eines weltweit eindeutigen URIs im folgenden Format spezifiziert:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.
Dafür können die Methodendefinitionen in der Dokumentation der HTTP 1.1-Standards hilfreich sein. Hier finden Sie auch die Spezifikationen für GET, POST, PUT und DELETE.
Grundlagen von JSON
Die Admin API gibt Daten im JSON-Format zurück.
JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.