Definieren von Schemadefinitionen für eine API

Schemakomponenten definieren wiederverwendbare Schemata, die Entwicklern Informationen zu der Anforderung bereitstellen, die sie senden sollten, oder die Antwort, die sie beim Aufrufen einer API-Operation erwarten sollten.

Informationen zu dieser Task

Hinweis: Diese Task bezieht sich auf die Konfiguration einer OpenAPI 2.0 . Details zum Konfigurieren einer OpenAPI 3.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 3.0 -API-Definition.

Eine in OpenAPI 2.0 erstellte API enthält einen Abschnitt, in dem API-Nutzdatendefinitionen definiert sind. Die Nutzdatendefinitionen beschreiben die Struktur von Daten, die in API-Anforderungen und -Antworten übertragen werden, und verwenden eine spezielle JSON-Schemavariante, die für OpenAPIspezifisch ist. Jede Nutzdatendefinition entspricht einem Schema, das die erwarteten Datenfelder auflistet. Diese Datenfelder werden als Eigenschaften im Schema dargestellt und enthalten eine Gruppe von Attributen, die ihren Typ, zulässige Werte, obligatorischen Status und andere Merkmale beschreiben. Obwohl zahlreiche Attribute verfügbar sind, werden die meisten von ihnen selten verwendet.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Sie können jederzeit direkt zur zugrunde liegenden OpenAPI -YAML-Quelle wechseln, indem Sie auf das Symbol Quelle Symbol für OpenAPI -Quelleklicken. Klicken Sie auf das Symbol Formular Formularsymbol, um zum Designformular zurückzukehren.

Vorgehensweise

  1. Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 2.0 -API-Definitionbeschrieben.
  2. Wenn bereits mindestens ein Schema definiert ist, erweitern Sie Definitionen.
  3. Sie können ein neues Schema erstellen oder ein vorhandenes Schema bearbeiten.
    • Klicken Sie zum Erstellen eines Schemas auf das Symbol 'Hinzufügen' OpenAPI 2.0 Symbol für Hinzufügen von APIs neben Definitionenund lesen Sie anschließend den Abschnitt Schemadefinitionen erstellen.
    • Wenn Sie ein vorhandenes Schema bearbeiten möchten, klicken Sie im Navigationsfenster auf den Namen der Schemakomponente und lesen Sie anschließend Schemadefinitionen bearbeiten.