Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Unterstützung für OpenAPI Specification 3.0

Entwerfen Sie eine API mit der OpenAPI Specification (OAS) 3.0 mithilfe von Talend Cloud API Designer.

Die 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

Anhand von Kombinationen, d. h. durch die Verknüpfung verschiedener Datentypen miteinander, können Sie neue Datentypen erstellen. Talend Cloud API Designer unterstützt zwei Typen von Kombinationen:
  • Komposition (allOf) - Ermöglicht die Aggregation der Schemaeigenschaften verschiedener Schemas. Ein Beispiel: Sie definieren den Datentyp anatomy (Anatomie), indem Sie alle Eigenschaften der bestehenden Typen nervousSystem (Nervensystem), skeleton (Skelett) und digestiveSystem (Verdauungssystem) wiederverwenden.
    Beispiel einer Komposition.
  • Polymorphie (oneOf /anyOf) - Ermöglicht die Erstellung einer Entität, die die Eigenschaften verschiedener Datentypen verwenden kann.
    • oneOf ermöglicht die Definition eines Datentyps mit den Eigenschaften eines der ausgewählten Typen. Ein Beispiel: Sie erstellen eine Operation, die Informationen zu einem Organ abruft. Sie können dann mithilfe der oneOf-Kombination eine Antwort definieren, um entweder alle Eigenschaften von brain (Gehirn) oder alle Eigenschaften von heart (Herz) abzurufen.
      Beispiel einer Polymorphie.
    • anyOf ermöglicht die Definition eines Datentyps mit den Eigenschaften eines oder mehrerer der ausgewählten Typen. Ein Beispiel: Sie definieren den Datentyp nervousSystem (Nervensystem) sowie den Typ skeleton (Skelett) mit unterschiedlichen Eigenschaften und verwenden die Kombination anyOf, um einen Datentyp zu erstellen, der Eigenschaften von einem dieser Typen oder von beiden enthält.
      Screenshot des Datentyps nervousSystem. Screenshot des Datentyps skeleton.

      Eine anyOf-Kombination ist gültig, solange sie alle erforderlichen Parameter von mindestens einem der ausgewählten Datentypen enthält. Im nachstehenden Beispiel werden die Eigenschaft brain_weight (Gehirn_Gewicht) des Typs nervousSystem (Nervensystem) und die Eigenschaften skull_height (Schädel_Höhe) und teeth (Zähne) des Typs skeleton (Skelett) verwendet.

      Beispiel einer Kombination unter Verwendung der Datentypen nervousSystem und skeleton.

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 z. B. 200 zu definieren, können Sie den Wert 2XX festlegen, 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, erhalten Vorrang vor Antwortbereichen und Standardantworten. Antwortbereiche wiederum erhalten Vorrang vor Standardantworten. In folgendem Beispiel:
  • Die Antwort 204 wurde definiert und erhält Vorrang vor den anderen Antworten.
  • Die Antwort 2XX gilt für die Antwortcodes 200 bis 203 und 205 bis 299.
  • Die Standard-Antwort gilt für alle Antworten 1XX, 3XX, 4XX und 5XX.
Antwortbeispiel.

Sicherheit

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

Einschränkungen

OAS 3.0 ermöglicht Ihnen die Angabe, 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.

Einschränkungsbeispiel.

In diesem Abschnitt

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