API bereitstellen und testen

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

Hinweise

API bereitstellen

Sie können Ihre API mit den App Engine-Plug-ins für Apache Maven oder Gradle bereitstellen. Verwenden Sie den Befehl für Ihr Plug-in, um die API in einer App Engine-Standardproduktionsumgebung bereitzustellen:

  1. Verwenden Sie den Befehl für Ihr Plug-In:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Warten Sie, bis die Bereitstellung abgeschlossen ist.
  3. Senden Sie eine Testanfrage an die bereitgestellte API. Verwenden Sie beispielsweise curl:

    curl \
        -H "Content-Type: application/json" \
        -X POST \
        -d '{"message": "echo"}' \
        "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"
    

    Die Antwort sieht etwa so aus:

    {
      "message": "echo echo"
    }
    

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

Mehrere Anwendungsversionen bereitstellen

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

API-Back-Ends lokal ausführen und testen

So testen Sie die API lokal:

  1. Erstellen Sie das Projekt im Stammverzeichnis des Projekts. Beispiel:

    Maven

    mvn clean package

    Gradle

    gradle clean build
  2. Starten Sie den App Engine-Entwicklungsserver. Beispiel:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun
  3. Testen Sie die API mit einer API-Anfrage. Verwenden Sie beispielsweise curl:

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

API über anderen Pfad bereitstellen

Wenn Sie die API über einen anderen Pfad bereitstellen möchten, ändern Sie in der Datei web.xml den Wert url-pattern im Abschnitt EndpointsServlet und stellen Sie die API noch einmal bereit. Beispiel:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

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.