Mithilfe der Gateway-Konsole CORS auf einer Ressource aktivieren API

Sie können die API Gateway-Konsole verwenden, um die CORS Unterstützung für eine oder alle Methoden auf einer von Ihnen erstellten REST API Ressource zu aktivieren. Nachdem Sie den COR Support aktiviert haben, legen Sie das Passthrough-Verhalten für die Integration auf NEVER fest. In diesem Fall wird die Methodenanforderung eines Inhaltstyps, dem keine Zuordnung zugewiesen wurde, mit der Antwort HTTP 415 Nicht unterstützter Medientyp zurückgewiesen. Weitere Informationen finden Sie unter Integrations-Pass-Through-Verhalten.

Wichtig

Ressourcen können untergeordnete Ressourcen enthalten. Wenn die CORS Unterstützung für eine Ressource und ihre Methoden aktiviert wird, wird sie nicht rekursiv für untergeordnete Ressourcen und deren Methoden aktiviert.

Um die CORS Unterstützung für eine REST API Ressource zu aktivieren

1. Melden Sie sich unter https://console.aws.amazon.com/apigateway bei der API Gateway-Konsole an.

2. Wählen Sie ein API.

3. Wählen Sie eine Ressource unter Resources.

4. Wählen Sie im Abschnitt Ressourcendetails die Option Aktivieren ausCORS.

   

5. Gehen Sie im CORS Feld Aktivieren wie folgt vor:

   1. (Optional) Wenn Sie eine benutzerdefinierte Gateway-Antwort erstellt haben und die CORS Unterstützung für eine Antwort aktivieren möchten, wählen Sie eine Gateway-Antwort aus.

   2. Wählen Sie jede Methode aus, um den CORS Support zu aktivieren. Die OPTION Methode muss CORS aktiviert sein.

      Wenn Sie die CORS Unterstützung für eine ANY Methode aktivieren, CORS ist sie für alle Methoden aktiviert.

   3. Geben Sie im Eingabefeld Access-Control-Allow-Headers eine statische Zeichenfolge einer durch Kommata getrennten Liste der Header ein, die der Client in der tatsächlichen Anforderung der Ressource senden muss. Verwenden Sie die von der Konsole bereitgestellte Header-Liste mit 'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token' oder geben Sie Ihren eigenen Header an.

   4. Verwenden Sie den von der Konsole bereitgestellten Wert '*' als Access-Control-Allow-Origin-Header-Wert, um Zugriffsanforderungen von allen Ursprüngen zuzulassen, oder geben Sie Ursprünge an, die auf die Ressource zugreifen dürfen.

   5. Wählen Sie Speichern.

   

   Wichtig

   Wenn Sie die obigen Anweisungen auf die ANY Methode in einer Proxyintegration anwenden, werden keine entsprechenden CORS Header festgelegt. Stattdessen muss Ihr Backend die entsprechenden CORS Header zurückgeben, z. B. Access-Control-Allow-Origin

Nachdem CORS die GET Methode aktiviert wurde, wird der Ressource eine OPTIONS Methode hinzugefügt, sofern sie noch nicht vorhanden ist. Die 200-Antwort der OPTIONS-Methode wird automatisch so konfiguriert, dass sie die drei Access-Control-Allow-*-Header zurückgibt, um die Preflight-Handshakes zu erfüllen. Darüber hinaus ist die tatsächliche (GET-) Methode standardmäßig auch so konfiguriert, dass sie den Access-Control-Allow-Origin-Header auch in seiner 200-Antwort zurückgibt. Für andere Arten von Antworten müssen Sie sie manuell konfigurieren, sodass sie den Access-Control-Allow-Origin'-Header mit "*" oder bestimmten Ursprüngen zurückgeben, wenn Sie den Cross-origin access-Fehler nicht zurückgeben möchten.

Nachdem Sie den CORS Support für Ihre Ressource aktiviert haben, müssen Sie die bereitstellen oder erneut bereitstellen, API damit die neuen Einstellungen wirksam werden. Weitere Informationen finden Sie unter Eine Bereitstellung auswählen.

Anmerkung

Wenn Sie den CORS Support für Ihre Ressource nicht aktivieren können, nachdem Sie das Verfahren befolgt haben, empfehlen wir Ihnen, Ihre CORS Konfiguration mit der API /pets Beispielressource zu vergleichen. Informationen zur Erstellung des API Beispiels finden Sie unterTutorial: Erstellen einer REST-API durch Importieren eines Beispiels.