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 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 -Quelle Sie auf das Symbol „Quelle“ klicken. Um zum Entwurfsformular zurückzukehren, klicken Sie auf das Formular -Symbol Formularsymbol .

Vorgehensweise

Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 3.0 -API-Definitionbeschrieben.
Erweitern Sie Pfadeund erweitern Sie anschließend den erforderlichen Pfad.
Erweitern Sie Operationen, erweitern Sie die erforderliche Operation und klicken Sie dann auf Externe Dokumentation.
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.
Klicken Sie anschließend auf Speichern .