Externe Dokumentation für eine API angeben

Online bearbeiten

Sie können auf eine externe Ressource mit erweiterter Dokumentation für eine API 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 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. Erweitern Sie den Abschnitt Allgemein und klicken Sie auf Externe Dokumentation.
  3. Geben Sie die folgenden Informationen an:
    • URL (erforderlich): Die URL für die Zieldokumentation.
    • Beschreibung: Eine optionale Beschreibung der Zieldokumentation. Für die Darstellung von Rich Text können Sie die Syntax „ CommonMark “ verwenden.
  4. Klicken Sie anschließend auf Speichern .