Nutzungspläne für REST APIs in API Gateway testen

Verwenden wir als Beispiel die PetStore API, die in erstellt wurdeTutorial: Erstellen einer REST-API durch Importieren eines Beispiels. Die API ist für die Verwendung des API-Schlüssels konfigurier Hiorr45VR...c4GJc. In den folgenden Schritten wird das Testen eines Nutzungsplans beschrieben.

So testen Sie den Nutzungsplan

• Führen Sie eine GET-Anforderung für die Ressource "Pets" (/pets) mit den Abfrageparametern ?type=...&page=... der API (zum Beispiel xbvxlpijch) in einem Nutzungsplan aus:

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  Anmerkung

  Sie müssen diese Anforderung an die Komponente execute-api von API Gateway übermitteln und den erforderlichen API-Schlüssel (zum Beispiel Hiorr45VR...c4GJc) im entsprechenden x-api-key-Header bereitstellen.

  Bei einer erfolgreichen Antwort wird der Statuscode 200 OK sowie eine Nutzlast mit den angeforderten Ergebnissen aus dem Backend zurückgegeben. Falls Sie den x-api-key-Header nicht oder mit einem falschen Schlüssel gesetzt haben, erhalten Sie als Antwort die Meldung 403 Forbidden. Wenn Sie allerdings nicht festgelegt haben, dass für die Methode ein API-Schlüssel erforderlich ist, erhalten Sie in jedem Fall die Antwort 200 OK – unabhängig davon, ob der x-api-key-Header korrekt oder fehlerhaft eingerichtet wurde – und die Ablehnungs- und Kontingentlimits werden ignoriert.

  Im Falle, dass API Gateway aufgrund eines internen Fehlers die im Nutzungsplan enthaltenen Drosselungs- und Kontingentlimits für diese Anforderung nicht erzwingen kann, führt API Gateway die Anforderung ohne Berücksichtigung der Limits aus. Es wird jedoch die Fehlermeldung CloudWatch in Usage Plan check failed due to an internal error protokolliert. Diese gelegentlich auftretenden Fehler können Sie ignorieren.