Kompatibilitätsmodus für API-Gateways

API Designer bietet einen Kompatibilitätsmodus für API-Gateways, mit dem Sie Ihre Definition in AWS API Gateway und Azure API Management importieren können.

Beim Exportieren Ihrer API im Kompatibilitätsmodus für Gateways kann API Designer Ihre Definition so ändern, dass sie erfolgreich in das ausgewählte Gateway importiert werden kann.

In bestimmten Fällen gibt es keine Änderungen. Es wird jedoch eine Meldung angezeigt, in der Sie über das Kompatibilitätsproblem informiert werden, das bei der von Ihnen exportierten Definition auftreten kann.

Exportieren einer OAS 3.0-Definition für AWS API Gateway

In der folgenden Tabelle wird beschrieben, wie API Designer die von AWS API Gateway nicht unterstützten Funktionen beim Exportieren einer Definition verarbeitet und was in AWS API Gateway beim Importieren der Definition geschieht.

Nicht unterstützte OpenAPI-Funktion	Verhalten von API Designer beim Export	Verhalten von AWS API Gateway beim Import
Das Attribut example wird nicht unterstützt.	Das Attribut wird beibehalten.	Das Attribut wird aus dem Schema entfernt.
Das Attribut readOnly wird nicht unterstützt.	Das Attribut wird beibehalten.	Das Attribut wird aus dem Schema entfernt.
Das Attribut additionalProperties wird nicht unterstützt.	Das Attribut wird beibehalten, und eine Informationsmeldung wird angezeigt.	Eine Warnmeldung wird angezeigt, die ignoriert werden kann, während die Definition erfolgreich importiert wird.
Typen der Sicherheitsdefinition: oauth2 wird nicht unterstützt, http wird nicht unterstützt, openIdConnect wird nicht unterstützt.	Die Sicherheitsschemas werden beibehalten, und eine Informationsmeldung wird angezeigt.	Eine Warnmeldung wird angezeigt, die ignoriert werden kann, während die Definition erfolgreich importiert wird.
Primitive Datentypen in Antworten werden nicht unterstützt.	Der primitive Typ wird in ein Komponentenschema eingebettet, und eine Warnmeldung wird angezeigt.	Der Import verläuft erfolgreich.
Medientyp-Bereiche werden nicht unterstützt.	Die Anfrage oder Antwort wird beibehalten, und eine Informationsmeldung wird angezeigt.	Der Import schlägt fehl, und eine Warnmeldung wird angezeigt.
Standardantwort wird nicht unterstützt.	Die Antwort wird beibehalten, und eine Informationsmeldung wird angezeigt.	Der Import schlägt fehl, und eine Warnmeldung wird angezeigt.
Bereichsantworten werden nicht unterstützt.	Die Antwort wird beibehalten, und eine Informationsmeldung wird angezeigt.	Der Import schlägt fehl, und eine Warnmeldung wird angezeigt.
Pfadvariablen, Abfrageparameter und Header müssen eindeutige Namen aufweisen.	Die Parameter werden beibehalten, und eine Fehlermeldung wird angezeigt.	Der Import schlägt fehl.

Exportieren einer OAS/Swagger 2.0-Definition für Azure API Management

In der folgenden Tabelle wird beschrieben, wie API Designer die von Azure API Management nicht unterstützten Funktionen beim Exportieren einer Definition verarbeitet und was in Azure API Management beim Importieren der Definition geschieht.

Nicht unterstützte OpenAPI-Funktion	Verhalten von API Designer beim Export	Verhalten von Azure API Management beim Import
Erforderliche Parameter für Pfade und Abfragen müssen eindeutige Namen aufweisen.	Eine Fehlermeldung wird angezeigt.	Der Import schlägt fehl.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab