Clientbibliothek generieren

Auf dieser Seite wird beschrieben, wie Sie von Ihrer Python-Back-End-API aus (dem Code, der auf dem Server ausgeführt wird) eine Clientbibliothek generieren. Diese Bibliothek kann von allen Java- oder Android-Apps zum Aufrufen der API verwendet werden.

Zum Erstellen von iOS-Clients für Ihre API empfehlen wir die Verwendung der Google API-Clientbibliothek für Objective-C für REST APIs.

Informationen zu JavaScript-Anwendungen finden Sie unter Authentifizierte Anfrage von JavaScript aus senden.

Hinweis

  • Laden Sie die Cloud Endpoints Frameworks-Bibliothek und -Tools in Ihr Anwendungsverzeichnis herunter, wie unter Erste Schritte mit Endpoints Frameworks beschrieben.
  • Der API-Code muss ordnungsgemäß mit dem erwarteten Frameworks-Code dekoriert sein.

Clientbibliothek generieren

Die folgende Anleitung zeigt, wie Sie mit dem Frameworks-Befehlszeilentool anhand des Beispielcodes aus Erste Schritte mit Cloud Endpoints ein Gradle-Client-Bundle generieren.

Clientbibliothek generieren:

  1. Wechseln Sie in das Verzeichnis, das die API-app.yaml-Datei und die API-Klassen enthält.

  2. Das Endpoints-Befehlszeilentool sollte in etwa so ausgeführt werden:

    python lib/endpoints/endpointscfg.py get_client_lib java -bs gradle main.EchoApi
    

    Dabei ist main die Klasse mit Ihrer API und EchoApi der API-Name.

    Warten Sie, bis die Bibliothek generiert wurde. Zur Bestätigung wird im Anschluss in etwa folgende Meldung eingeblendet:

    API client library written to ./echo-v1.zip
    
  3. Entpacken Sie die Datei mit dem ZIP-Programm oder verwenden Sie ein anderes ZIP-kompatibles Reaktivierungsprogramm:

    unzip ./echo-v1-java.zip
    
  4. Ändern Sie das Verzeichnis:

    cd echo
    
  5. Erstellen Sie die Clientbibliothek:

    gradle build
    

    Die Ausgabe befindet sich im Verzeichnis build/libs. Der genaue Dateiname hängt von der Version des Clients ab. Er ähnelt echo-v1-1.23.0-SNAPSHOT.jar.

  6. Fügen Sie der App die JAR-Datei der Clientbibliothek hinzu.

  7. Wiederholen Sie diese Schritte bei jeder Änderung des API-Codes.

Nächste Schritte

Weitere Informationen und einen Beispielcode für den Zugriff auf eine Back-End-API über einen Python-Client finden Sie unter Über Python-Clients auf Back-End-APIs zugreifen.