Erstellen Sie eine "Hello, World!"- Lambda-Funktion Erstellen der "Hello, World!"- API Bereitstellen und Testen der API

Tutorial: Erstellen einer REST-API mit einer Lambda-Proxy-Integration

Lambda-Proxy-Integration ist ein einfacher, flexibler API Gateway API-Integrationstyp, der es Ihnen ermöglicht, eine API-Methode – oder eine ganze API – mit einer Lambda-Funktion zu integrieren. Die Lambda-Funktion kann in jeder Sprache, die Lambda unterstützt geschrieben werden. Da es sich um eine Proxy-Integration handelt, können Sie die Implementierung der Lambda-Funktion jederzeit ändern, ohne Ihre API erneut bereitstellen zu müssen.

In diesem Tutorial führen Sie folgende Aufgaben aus:

Erstellen Sie eine "Hello, World!"- Die Lambda-Funktion ist das Backend für die API.
Erstellen und testen Sie eine "Hello, World!"- API mit Lambda-Proxy-Integration.

Themen

Erstellen Sie eine "Hello, World!"- Lambda-Funktion
Erstellen Sie eine "Hello, World!"- API
Bereitstellen und Testen der API

Erstellen Sie eine "Hello, World!"- Lambda-Funktion

Erstellen von „Hello, World!“ Lambda-Funktion in der Lambda-Konsole

Melden Sie sich bei der Lambda-Konsole unter https://console.aws.amazon.com/lambda an.
Wählen Sie in der AWS Navigationsleiste eine aus. AWS-Region

Anmerkung
Notieren Sie die Region, in der Sie die Lambda-Funktion erstellen. Sie benötigen sie zum Erstellen der API.
Wählen Sie im Navigationsbereich Functions (Funktionen) aus.
Wählen Sie Create function (Funktion erstellen).
Wählen Sie Author from scratch aus.
Führen Sie unter Basic information (Grundlegende Informationen) die folgenden Schritte aus:
1. Geben Sie in Function name (Funktionsname) GetStartedLambdaProxyIntegration ein.
2. Wählen Sie für Laufzeit die neueste unterstützte Node.js- oder Python-Laufzeit aus.
3. Behalten Sie für Architektur die Standardeinstellung bei.
4. Erweitern Sie unter Berechtigungen die Option Standardausführungsrolle ändern. Wählen Sie in der Dropdown-Liste Ausführungsrolle die Option Neue Rolle aus AWS -Richtlinienvorlagen erstellen aus.
5. Geben Sie in Role Name (Rollenname) den Namen GetStartedLambdaBasicExecutionRole ein.
6. Lassen Sie das Feld Policy templates (Richtlinien-Vorlagen) leer.
7. Wählen Sie Create function (Funktion erstellen).

Fügen Sie im Inline-Code-Editor unter Function code (Funktionscode) den folgenden Code ein:

Node.js


export const handler = async(event, context) => {
    console.log('Received event:', JSON.stringify(event, null, 2));
    var res ={
        "statusCode": 200,
        "headers": {
            "Content-Type": "*/*"
        }
    };
    var greeter = 'World';
    if (event.greeter && event.greeter!=="") {
        greeter =  event.greeter;
    } else if (event.body && event.body !== "") {
        var body = JSON.parse(event.body);
        if (body.greeter && body.greeter !== "") {
            greeter = body.greeter;
        }
    } else if (event.queryStringParameters && event.queryStringParameters.greeter && event.queryStringParameters.greeter !== "") {
        greeter = event.queryStringParameters.greeter;
    } else if (event.multiValueHeaders && event.multiValueHeaders.greeter && event.multiValueHeaders.greeter != "") {
        greeter = event.multiValueHeaders.greeter.join(" and ");
    } else if (event.headers && event.headers.greeter && event.headers.greeter != "") {
        greeter = event.headers.greeter;
    } 
    res.body = "Hello, " + greeter + "!";
    return res
};

Python


import json


def lambda_handler(event, context):
    print(event)

    greeter = 'World'

    try:
        if (event['queryStringParameters']) and (event['queryStringParameters']['greeter']) and (
                event['queryStringParameters']['greeter'] is not None):
            greeter = event['queryStringParameters']['greeter']
    except KeyError:
        print('No greeter')

    try:
        if (event['multiValueHeaders']) and (event['multiValueHeaders']['greeter']) and (
                event['multiValueHeaders']['greeter'] is not None):
            greeter = " and ".join(event['multiValueHeaders']['greeter'])
    except KeyError:
        print('No greeter')

    try:
        if (event['headers']) and (event['headers']['greeter']) and (
                event['headers']['greeter'] is not None):
            greeter = event['headers']['greeter']
    except KeyError:
        print('No greeter')

    if (event['body']) and (event['body'] is not None):
        body = json.loads(event['body'])
        try:
            if (body['greeter']) and (body['greeter'] is not None):
                greeter = body['greeter']
        except KeyError:
            print('No greeter')

    res = {
        "statusCode": 200,
        "headers": {
            "Content-Type": "*/*"
        },
        "body": "Hello, " + greeter + "!"
    }

    return res

Wählen Sie Deploy (Bereitstellen) aus.

Erstellen Sie eine "Hello, World!"- API

Erstellen Sie jetzt eine API für Ihre "Hello World" Lambda-Funktion unter Verwendung der API Gateway-Konsole.

Erstellen von „Hello, World!“ API

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wenn Sie API Gateway zum ersten Mal verwenden, sehen Sie eine Seite, die Sie mit den Funktionen des Service vertraut macht. Wählen Sie unter REST-API die Option Erstellen aus. Wenn das Popup-Fenster Create Exampe API (Beispiel-API erstellen) angezeigt wird, klicken Sie auf OK.

Wenn Sie API Gateway nicht zum ersten Mal verwenden, wählen Sie Create API (API erstellen). Wählen Sie unter REST-API die Option Build (Erstellen) aus.
Geben Sie in API name (API-Name) LambdaProxyAPI ein.
(Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.
Lassen Sie die Einstellung für API-Endpunkttyp bei Regional.
Wählen Sie als IP-Adresstyp die Option. IPv4
Wählen Sie Create API (API erstellen) aus.

Nachdem Sie eine API erstellt haben, können Sie nun eine Ressource erstellen. In der Regel werden API-Ressourcen in einer Ressourcenstruktur organisiert, die der Anwendungslogik entspricht. Für dieses Beispiel erstellen Sie eine /helloworld-Ressource.

Erstellen Sie eine Ressource

Wählen Sie Create Resource (Ressource erstellen) aus.
Die Proxy-Ressource bleibt ausgeschaltet.
Ressourcenpfad wird als / beibehalten.
Geben Sie für Resource name (Ressourcenname) helloworld ein.
CORS (Cross Origin Resource Sharing) bleibt ausgeschaltet.
Wählen Sie Create Resource (Ressource erstellen) aus.

In einer Proxy-Integration wird die gesamte Anfrage unverändert an die Backend-Lambda-Funktion gesendet. Dazu wird eine Catch-All-ANY-Methode verwendet, die eine HTTP-Methode repräsentiert. Der tatsächliche HTTP-Methode wird vom Client zur Laufzeit angegeben. Mit der Methode ANY haben Sie die Möglichkeit, eine einzige API-Methodeneinrichtung für alle unterstützten HTTP-Methoden zu verwenden: DELETE, GET, HEAD, OPTIONS, PATCH, POST und PUT.

Erstellen einer `ANY`-Methode

Wählen Sie die /helloworld-Ressource aus und klicken Sie dann auf Methode erstellen.
Wählen Sie als Methodentyp die Option BELIEBIG aus.
Wählen Sie für den Integration type (Integrationstyp) die Option Lambda function (Lambda-Funktion) aus.
Schalten Sie die Lambda-Proxy-Integration ein.
Wählen Sie für Lambda-Funktion den Ort aus, AWS-Region an dem Sie Ihre Lambda-Funktion erstellt haben, und geben Sie dann den Funktionsnamen ein.
Wenn Sie die Standardzeitüberschreitung von 29 Sekunden verwenden möchten, lassen Sie das Kontrollkästchen Default timeout (Standardzeitüberschreitung) aktiviert. Wenn Sie einen benutzerdefinierten Zeitüberschreitungswert festlegen möchten, wählen Sie Default timeout (Standardzeitüberschreitung) aus und geben Sie einen Zeitüberschreitungswert zwischen 50 und 29000 Millisekunden ein.
Wählen Sie Methode erstellen aus.

Bereitstellen und Testen der API

Stellen Sie Ihre API bereit

Klicken Sie auf Deploy API.
Wählen Sie für Stufe die Option Neue Stufe aus.
Geben Sie für Stage name (Stufenname) test ein.
(Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.
Wählen Sie Bereitstellen.
Wählen Sie unter Stufendetails das Kopiersymbol aus, um die Aufruf-URL Ihrer API zu kopieren.

Browser und cURL verwenden, um eine API mit Lambda-Proxy-Integration zu testen

Sie können einen Browser oder eine cURL zum Testen Ihrer API verwenden.

Um GET-Anforderungen nur mit Abfragezeichenfolgeparametern zu testen, können Sie die URL der API-helloworld-Ressource in die Adressleiste eines Browsers eingeben.

Fügen Sie die Ressource helloworld und den Abfragezeichenfolgeparameter ?greeter=John an Ihre Aufruf-URL an, um die URL für die API-helloworld-Ressource zu erstellen. Ihre URL sollte wie folgt aussehen.


https://r275xc9bmd.execute-api.us-east-1.amazonaws.com/test/helloworld?greeter=John

Für andere Methoden müssen Sie erweiterte REST-API-Testtools wie POSTMAN oder cURL verwenden. In diesem Tutorial wird cURL verwendet. Bei den cURL-Befehl-Beispielen wird davon ausgegangen, dass cURL auf Ihrem Computer installiert ist.

So testen Sie die bereitgestellte API mithilfe von cURL:

Öffnen Sie ein Terminal-Fenster.
Kopieren Sie den folgenden cURL-Befehl und fügen Sie ihn in das Terminalfenster ein. Ersetzen Sie dann die Aufruf-URL mit der URL, die Sie zuvor kopiert haben und fügen Sie dann /helloworld am Ende der URL hinzu.
Anmerkung
Wenn Sie den Befehl unter Windows ausführen, verwenden Sie stattdessen die folgende Syntax:
```
curl -v -X POST "https://r275xc9bmd.execute-api.us-east-1.amazonaws.com/test/helloworld" -H "content-type: application/json" -d "{ \"greeter\": \"John\" }"
```
1. So rufen Sie die API mit dem Abfragezeichenfolgeparameter ?greeter=John auf:
```
curl -X GET 'https://r275xc9bmd.execute-api.us-east-1.amazonaws.com/test/helloworld?greeter=John'
```
2. So rufen Sie die API mit einem Header-Parameter von greeter:John auf:
```
curl -X GET https://r275xc9bmd.execute-api.us-east-1.amazonaws.com/test/helloworld \
  -H 'content-type: application/json' \
  -H 'greeter: John'
```
3. So rufen Sie die API mit einem Textkörper von {"greeter":"John"} auf:
```
curl -X POST https://r275xc9bmd.execute-api.us-east-1.amazonaws.com/test/helloworld \
  -H 'content-type: application/json' \
  -d '{ "greeter": "John" }'
```
In allen Fällen ist die Ausgabe eine Antwort mit dem folgenden Antworttext: 200
```
Hello, John!
```

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Wählen Sie ein Tutorial zur Lambda-Integration aus

Tutorial: Erstellen einer REST-API mit einer Lambda-Nicht-Proxy-Integration