Schema-Definitionen für eine API festlegen

Online bearbeiten

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 unter OpenAPI 2.0 erstellte API enthält einen Abschnitt, in dem die Definitionen der API-Nutzdaten festgelegt sind. Die Payload-Definitionen beschreiben die Struktur der Daten, die in API-Anfragen und -Antworten übertragen werden, und nutzen dabei eine spezielle, für OpenAPI spezifische Variante des JSON-Schemas. Jede Payload-Definition entspricht einem Schema, in dem die erwarteten Datenfelder aufgeführt sind. Diese Datenfelder werden im Schema als Eigenschaften dargestellt und umfassen eine Reihe von Attributen, die ihren Typ, die zulässigen Werte, den Pflichtstatus und weitere Merkmale beschreiben. Obwohl zahlreiche Attribute zur Verfügung stehen, werden die meisten davon nur selten genutzt.

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 YAML-Quelle von „ OpenAPI “ wechseln, indem Symbol für OpenAPI -QuelleSie auf das Symbol „Quelle“ klicken. Um zum Entwurfsformular zurückzukehren, klicken Sie auf das Formular -Symbol Formularsymbol.

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.
    • Um ein Schema zu erstellen, klicken Sie auf das Symbol OpenAPI 2.0 Symbol für Hinzufügen von APIs „Hinzufügen“ neben „Definitionen “ und lesen Sie anschließend den Abschnitt „Schema-Definitionen erstellen “.
    • Um ein vorhandenes Schema zu bearbeiten, klicken Sie im Navigationsbereich auf den Namen der Schemakomponente und lesen Sie anschließend den Abschnitt „Schemadefinitionen bearbeiten “.