Unterstützung für OpenAPI Specification 3.0 | Qlik Cloud Hilfe
Zu Hauptinhalt springen Zu ergänzendem Inhalt springen
Qlik Ressourcen
SearchUnify-Suche wird geladen Wenn Sie Unterstützung für Ihr Produkt benötigen, wenden Sie sich an den Qlik-Support.
Qlik Kundenportal
SearchUnify-Suche wird geladen Wenn Sie Unterstützung für Ihr Produkt benötigen, wenden Sie sich an den Qlik-Support.
Qlik Kundenportal

Unterstützung für OpenAPI Specification 3.0

Entwerfen Sie eine API mit OpenAPI Specification (OAS) 3.0 unter Verwendung von API Designer.

OpenAPI Specification 3.0 umfasst neue Funktionen, die API-Designer mit zusätzlichen Ausdrucksmöglichkeiten ausstatten und zu einer Steigerung der Produktivität beitragen.

Weitere Informationen zu OpenAPI finden Sie in der Swagger-Dokumentation.

Komponenten

Mithilfe von Komponenten können verschiedene Elemente global in einer API wiederverwendet werden. Hierbei kann es sich um folgende Elemente handeln:
  • Pfadvariablen
  • Abfrageparameter
  • Header
  • Antworten

Kombinationen

Kombinationen ermöglichen Ihnen die Erstellung eines neuen Datentyps, indem Sie mehrere andere Datentypen miteinander kombinieren. API Designer unterstützt zwei Arten von Kombinationen:
  • Komposition (allOf) – Ermöglicht die Aggregation der Schemaeigenschaften verschiedener Schemas. Beispiel: Sie definieren den Datentyp Company (Unternehmen), indem Sie alle Eigenschaften der bestehenden Typen Contact (Kontakt) und Error (Fehler) wiederverwenden.
    Beispiel einer Komposition.
  • Polymorphie (oneOf /anyOf) – Ermöglicht die Erstellung einer Entität, die die Eigenschaften verschiedener Datentypen verwenden kann.
    • oneOfermöglicht die Definition eines Datentyps mit den Eigenschaften eines der ausgewählten Typen. Wenn Sie beispielsweise eine Operation zum Abrufen von Informationen zu einem Dienstkonto erstellen, können Sie die Antwort mithilfe der oneOf-Kombination definieren, um entweder alle Eigenschaften von Error (Fehler) oder alle Eigenschaften von ServiceAccountCount (Anzahl der Dienstkonten) abrufen.
      Beispiel einer Polymorphie.
    • anyOf ermöglicht die Definition eines Datentyps mit den Eigenschaften eines oder mehrerer der ausgewählten Typen. Beispiel: Sie können den Datentyp nervousSystem (Nervensystem) sowie den Typ skeleton (Skelett) mit verschiedenen Eigenschaften definieren und die anyOf-Kombination verwenden, um einen Datentyp mit beliebigen Eigenschaften aus einem dieser Typen zu erstellen.

      Eine anyOf-Kombination ist solange gültig, wie sie alle erforderlichen Parameter mindestens eines der ausgewählten Datentypen enthält. Das folgende Beispiel verwendet die Eigenschaft brain_weight aus dem Typ nervousSystem (Nervensystem) und die Eigenschaften skull_height und teeth (Zähne) aus Skeleton (Skelett).

      Beispiel einer Kombination unter Verwendung der Datentypen nervousSystem (Nervensystem) und skeleton (Skelett).

Weitere Informationen zu Komposition und Polymorphie finden Sie unter Vererbung und Polymorphie und Unterschied zwischen anyOf und oneOf.

Antworten

OAS 3.0 ermöglicht Ihnen die Definition neuer Typen von Antworten für Ihre Operationen:
  • Antwortbereiche: Anstatt eine Antwort wie beispielsweise 200zu definieren, können Sie den Wert 2XX, der die Antworten 200 bis 299 umfasst.
  • Standardantworten: Sie können eine Standardantwort definieren, die zurückgegeben wird, wenn keine spezifische Antwort bzw. kein Antwortbereich verfügbar ist.
Antworten, die mit einem expliziten Code definiert wurden, haben Vorrang vor Antwortbereichen und Standardantworten. In folgendem Beispiel:
  • Die Antwort 204 wurde definiert und hat Vorrang vor den anderen Antworten.
  • Die Antwort 2XX gilt für die Antwortcodes 200 bis 203 und 205 bis 299.
  • Die Antwort default (Standard) gilt für alle 1XX-, 3XX-, 4XX- und 5XX-Antworten.
Abschnitt „Responses (Antworten)“.

Sicherheit

OAS 3.0 stellt neue Sicherheitsschemas für Ihre API bereit:
  • Bearer-Authentifizierung
  • OpenIdConnect

Einschränkungen

Mithilfe von OAS 3.0 können Sie angeben, dass bestimmte Eigenschaften schreibgeschützt oder auf einen Nur-Schreiben-Zugriff beschränkt sind.

Diese Option ist nur in Datentypen verfügbar und kann nicht in Requests oder Antworten auf Operationsebene definiert werden.

Beispiel für eine Einschränkung.

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