Externe Dokumentation für eine Operation angeben

Sie können auf eine externe Ressource mit erweiterter Dokumentation für eine API-Operation verweisen.

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.

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. Erweitern Sie Pfadeund erweitern Sie anschließend den erforderlichen Pfad.
  3. Erweitern Sie Operationen, erweitern Sie die erforderliche Operation und klicken Sie dann auf Externe Dokumentation.
  4. Geben Sie die folgenden Informationen an:
    • URL (erforderlich): Die URL für die Zieldokumentation.
    • Beschreibung: Eine optionale Beschreibung der Zieldokumentation. Sie können die CommonMark -Syntax für die Rich-Text-Darstellung verwenden.
  5. Klicken Sie anschließend auf Speichern .