Swagger
Der Swagger-Konnektor unterstützt eine Swagger-Datei mit den folgenden Authentifizierungstypen: Basic, OAuth und App Key. Dieser Konnektor unterstützt die Spezifikationen
OpenAPI 2.0 und
OpenAPI 3.0.
Version der Konnektorveröffentlichung
Der Swagger-Konnektor wurde in Version 8.4.3 bereitgestellt.
Unterstützte Aktion
Unterstützte Trigger
None
Unterstützte Autorisierungen
Der Swagger-Konnektor unterstützt die folgende Autorisierung:
• Keine
• Einfach
• OAuth
 |
Stellen Sie vor dem Hinzufügen einer OAuth-Verbindung sicher, dass Sie die Schritte für Swagger unter
Konnektor-OAuth-Einstellungen konfigurieren ausführen.
|
• Anwendungsschlüssel
Swagger autorisieren
Für jede Aktion des Swagger-Konnektors muss eine Swagger-Autorisierung durchgeführt werden. Wählen Sie eines der folgenden Schemata aus der Authentifizierungsschemaliste aus:
• Kein – Geben Sie die URL der Swagger-Datei an, z.B. https://petstore.swagger.io/v2/swagger.json
• Einfach – Gehen Sie wie folgt vor, um eine Basisverbindung hinzuzufügen:
1. Wählen Sie Einfach aus der Authentifizierungsschemaliste aus.
2. Klicken Sie im Feld Swagger-Verbindung auf Neu hinzufügen.
3. Geben Sie im Fenster "Verbindung hinzufügen" die folgenden Details ein:
▪ Verbindungsbeschriftung – Wird automatisch gefüllt. Sie können die Verbindungsbeschriftung Ihrer Wahl angeben.
|
|
Bei Beschriftungen wird die Groß-/Kleinschreibung beachtet. Leerzeichen, einige Sonderzeichen und vorangestellte Zahlen dürfen nicht verwendet werden.
|
▪ Swagger-URL – URL der Datei "Swagger.json".
▪ Benutzername – Benutzername für die Zielanwendung
▪ Passwort – Passwort für die Zielanwendung
4. Klicken Sie auf HINZUFÜGEN. Eine neue Autorisierung wird zur Liste hinzugefügt.
• OAuth – Gehen Sie wie folgt vor, um eine OAuth-Verbindung hinzuzufügen:
Voraussetzung: Stellen Sie vor dem Hinzufügen einer neuen OAuth-Verbindung sicher, dass Sie die Schritte im Swagger-Abschnitt des Themas
Konnektor-OAuth-Einstellungen konfigurieren befolgen.
1. Wählen Sie OAuth aus der Authentifizierungsschemaliste aus.
2. Klicken Sie im Feld Swagger-OAuth auf Add new Swagger login.
3. Geben Sie im Feld "Parameter" einen Wert für die Option Swagger URL ein und klicken Sie anschließend auf ZULASSEN. Das Fenster "Autorisierung hinzufügen" wird geöffnet.
4. Bearbeiten Sie im Fenster "Autorisierung hinzufügen" ggf. das Feld Autorisierungsbeschriftung und geben Sie dann die Ressourcen-URL ein.
5. Klicken Sie auf HINZUFÜGEN.
• Anwendungsschlüssel – Gehen Sie wie folgt vor, um eine neue Anwendungsschlüsselverbindung hinzuzufügen:
1. Wählen Sie Anwendungsschlüssel aus der Authentifizierungsschemaliste aus.
2. Klicken Sie im Feld Swagger AppKey auf Neu hinzufügen.
3. Geben Sie im Fenster "Verbindung hinzufügen" die folgenden Details ein:
▪ Verbindungsbeschriftung – Wird automatisch gefüllt. Sie können die Verbindungsbeschriftung Ihrer Wahl angeben.
|
|
Bei Beschriftungen wird die Groß-/Kleinschreibung beachtet. Leerzeichen, einige Sonderzeichen und vorangestellte Zahlen dürfen nicht verwendet werden.
|
▪ Swagger-URL – URL der Swagger-Datei, z.B. https://petstore.swagger.io/v2/swagger.json.
▪ Anwendungsschlüssel– Geben Sie den Swagger-Anwendungsschlüssel ein.
4. Klicken Sie auf HINZUFÜGEN.
|
|
Klicken Sie auf TESTEN, um die Autorisierung zu validieren.
|
Swagger-Konnektor – Einschränkungen
• Bei der Spezifikation OpenAPI 3.0 können für das Feld "Server" mehrere Basis-URLs definiert werden. Die aktuelle Implementierung unterstützt diese Option nicht. Stattdessen wird die erste Basis-URL vom Server-Array verwendet.
• Die folgenden Medientypen sind in der Abfrage erlaubt: application/json und application/x-www-form-urlencoded. Platzhalter sind nicht erlaubt. Für die Antwort ist application/json erlaubt.
• Hoch- oder Herunterladen von Dateien oder Bildern wird nicht unterstützt.
• Multipart/form-data wird nicht unterstützt.
• Parameterserialisierung ist der Standard für alle Parameter.
• Die Verwendung von "one of", "anyOf", "allOf" und "not" im Feld "Typ" wird nicht unterstützt.
• Mehrfache Authentifizierung ist nicht erlaubt. Alle APIs sollten eine ähnliche Authentifizierung verwenden.