Anforderungshauptteilkomponenten definieren

Online bearbeiten

Eine Anforderungshauptteilkomponente ist eine wiederverwendbare Definition der Struktur des Hauptteils einer API-Anforderung.

Informationen zu dieser Task

Hinweis:
  • Diese Task bezieht sich auf die Konfiguration einer OpenAPI 3.0-API-Definition. Details zum Konfigurieren einer OpenAPI 2.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 2.0 -API-Definition.
  • OpenAPI 3.0 -APIs werden nur mit dem DataPower® API Gatewayunterstützt, nicht mit dem DataPower Gateway (v5 compatible).
  • Details zu aktuellen OpenAPI 3.0 -Unterstützungseinschränkungen finden Sie unter OpenAPI 3.0 -Unterstützung in IBM® API Connect.

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 3.0 -API-Definitionbeschrieben.
  2. Erweitern Sie Komponenten . Wenn bereits mindestens eine Anforderungshauptteilkomponente definiert ist, erweitern Sie Anforderungskörper.
  3. Sie können eine neue Anforderungshauptteilkomponente erstellen oder eine bereits vorhandene Anforderungshauptteilkomponente bearbeiten.
    • Um eine Komponente für den Request-Body zu erstellen, klicken Sie auf das Symbol OpenAPI 3.0 Symbol für Hinzufügen von APIs „Hinzufügen“ neben „Request-Bodies “ und lesen Sie anschließend den Abschnitt „Erstellen eines Request-Bodys “.
    • Um eine vorhandene Komponente des Anfragetextes zu bearbeiten, klicken Sie im Navigationsbereich auf den Namen der Komponente und lesen Sie dann den Abschnitt „Bearbeiten eines Anfragetextes “.