API bereitstellen und testen

Auf dieser Seite wird beschrieben, wie Sie Ihre API bereitstellen.

Hinweise

API für die Produktion bereitstellen

So stellen Sie eine API bereit:

  1. Legen Sie die Umgebungsvariable ENDPOINTS_GAE_SDK auf den Pfad des App Engine SDK-Ordners fest: Path_to_Cloud_SDK/platform/google_appengine.

    Ersetzen Sie Path_to_Cloud_SDK durch die Ausgabe des folgenden Befehls:

     gcloud info --format="value(installation.sdk_root)"
    
  2. Führen Sie den folgenden Befehl im Hauptverzeichnis der API aus:

     gcloud app deploy
    

    Warten Sie kurz, bis die Bereitstellung abgeschlossen ist. Ignorieren Sie die Warnmeldungen. Nach Abschluss der Bereitstellung erhalten Sie in etwa folgende Meldung:

    File upload done.
    Updating service [default]...done.
    
  3. Prüfen Sie die erfolgreiche Bereitstellung, indem Sie eine Testanfrage an die API senden. Beispiel:

    curl --request POST \
       --header "Content-Type: application/json" \
       --data '{"content":"echo"}' \
       https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2
    

    Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID und echo durch den API-Namen.

    Die Ergebnisse sind:

    {
     "content": "echo echo"
    }
    

Wenn Sie als Antwort einen Fehler erhalten haben, lesen Sie die Informationen unter Fehlerbehebung bei Antwortfehlern.

Mehrere App-Versionen bereitstellen

Informationen zu Versionsverwaltung der API und zum Bereitstellen von Versionen finden Sie unter API-Versionsverwaltung handhaben.

API lokal testen

Sie können Ihre API mit dem lokalen App Engine-Entwicklungsserver lokal testen. Weitere Informationen zum lokalen Entwicklungsserver finden Sie unter Lokalen Entwicklungsserver verwenden.

So führen Sie die API lokal aus:

  1. Starten Sie den App Engine-Entwicklungsserver vom Stammverzeichnis des Projekts aus:

    dev_appserver.py YOUR_PROJECT_DIR
    
  2. Führen Sie curl aus, um eine API-Anfrage zu senden. Beispiel:

     curl --request POST \
        --header "Content-Type: application/json" \
        --data '{"message":"echo"}' \
        "${HOST}/_ah/api/echo/v1/echo?n=2"
    

API-Verwaltung hinzufügen

Endpoints Frameworks bietet API-Verwaltungsfunktionen wie z. B.:

Damit Ihre API von Endpoints Frameworks verwaltet werden kann, müssen Sie ein OpenAPI-Dokument generieren und bereitstellen, das Ihre API wie unter API-Verwaltung hinzufügen dargestellt beschreibt.