Einschränkungen der OpenAPI 2.0-Funktionen

In den folgenden Abschnitten werden die Einschränkungen der OpenAPI 2.0-Funktionen in API Gateway beschrieben.

Ignorierte Bereiche

Obwohl API Gateway OpenAPI-Dokumente akzeptiert, für die in einem Sicherheitsschemaobjekt Bereiche definiert wurden, werden diese Bereiche nicht geprüft oder erzwungen.

Mehrere Sicherheitsanforderungen

  • Anforderungen an API-Schlüssel: API Gateway unterstützt keine alternativen Sicherheitsanforderungen (logisches ODER), wenn eines der Schemas ein API-Schlüssel ist. Es werden jedoch Konjunktionen (logisches UND) unterstützt, sodass Sie sowohl einen API-Schlüssel als auch ein OAuth2-Token festlegen können.
  • OAuth2-Anforderungen: Alternative Sicherheitsanforderungen (logisches ODER) werden für verschiedene OAuth2-Sicherheitsschemas unterstützt.
  • Verknüpfte Sicherheitsanforderungen (logisches UND) für verschiedene OAuth2-Sicherheitsschemas werden nicht unterstützt.
  • Optionale Sicherheit: Eine leere Sicherheitsanforderung (- {}) kann verwendet werden, um die Sicherheit für einen API-Schlüssel optional zu machen. Dies wird jedoch für OAuth nicht unterstützt.

Validierung der Sicherheitsdefinition

API Gateway lehnt eine OpenAPI 3.x-Spezifikation ab, in der eine Sicherheitsanforderung ohne entsprechende Definition im Abschnitt securityDefinitions verwendet wird.

URL-Pfadvorlagen

API Gateway unterstützt nur URL-Pfadvorlagenparameter, die vollständige Pfadsegmente darstellen (z.B. /items/{itemId}). Parameter, die Teilsegmenten entsprechen (z. B. /items/prefix_{id}_suffix), werden nicht unterstützt und abgelehnt.

Parameter, Schemas und Typen

API Gateway akzeptiert OpenAPI-Dokumente mit verschiedenen Parameter- und Typdefinitionen (z.B. required-Parameter, Arrayformate), aber nicht erzwungen. Eingehende Anfragen werden unabhängig von diesen Definitionen an Ihre API weitergeleitet.

Verweise auf externe Typen

API Gateway unterstützt keine Verweise auf Typen außerhalb des bereitgestellten OpenAPI-Dokuments. Ein $ref, das auf eine externe URL verweist, ist beispielsweise nicht zulässig und wird abgelehnt.

Benutzerdefinierter Port in Hostadresse

API Gateway lässt keine benutzerdefinierten Ports im Feld host eines OpenAPI-Dokuments zu.

Einschränkungen für YAML-Aliasse

Ein an API Gateway gesendetes OpenAPI-Dokument kann maximal 200 YAML-Alias-Knoten haben.