Tags zu einer API hinzufügen

Online bearbeiten

Sie können Tags in die API-Definition einschließen. Solche Tags werden zur OpenAPI -Definition der API hinzugefügt, aber nicht von API Connect für die Indexierung verwendet.

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 Allgemein . Wenn bereits mindestens ein Tag definiert ist, erweitern Sie Tags.
  3. Um ein neues Tag hinzuzufügen, klicken Sie auf das Symbol OpenAPI 3.0 Symbol für Hinzufügen von APIs „Hinzufügen“ neben „Tags“ im Navigationsbereich. Um einen vorhandenen Tag zu bearbeiten, klicken Sie im Navigationsfenster auf den Tagnamen.
  4. Geben Sie die folgenden Informationen an:
    • Name (erforderlich): Der Name des Tags
    • Beschreibung: Eine optionale Beschreibung des Tags. Für die Darstellung von Rich Text können Sie die Syntax „ CommonMark “ verwenden.
    • Externe Dokumentation > URL (verfügbar bei der Bearbeitung eines bestehenden Tags): Die URL für die Zieldokumentation, die dieses Tag beschreibt.
    • Externe Dokumentation > Beschreibung (verfügbar bei der Bearbeitung eines bestehenden Tags): Eine optionale Beschreibung der Zieldokumentation.
  5. Wenn Sie einen neuen Tag erstellen, klicken Sie auf Erstellen.
    Die Tagdetails werden zur weiteren Bearbeitung angezeigt, wie in Schritt 4beschrieben.
  6. Klicken Sie anschließend auf Speichern .