Verwendung des API-Assistenten zur Verbesserung Ihrer API-Spezifikationen
Sie können den API-Assistenten verwenden, um Ihre OpenAPI 3.0 Spezifikationen zu analysieren und KI-Empfehlungen für Validierungskorrekturen und Dokumentationsverbesserungen zu erstellen. Die Verbesserung Ihrer API-Spezifikationen beschleunigt deren Annahme durch die Verbraucher.
Produktinfo
Der API-Assistent in IBM® API Connect Enterprise as a Service verwendet IBM watsonx Granite LLM Modelle, damit Sie Ihre APIs schneller erstellen können. Nutzen Sie den API-Assistenten, um schnell KI-Korrekturen für Ihre API-Definitionen zu erstellen und hilfreiche Beschreibungen und Beispiele für Ihre API-Dokumente vorzuschlagen.
- Fehler bei der Spezifikationsvalidierung
- Verbessern Sie Ihre API, indem Sie Ihre OpenAPI 3.0-Spezifikation analysieren und potenzielle KI-Fehlerbehebungen für alle Validierungsfehler generieren; siehe Verwendung des API-Assistenten zur Fehlerbehebung.
- Erweiterungen der Spezifikation
- Verbessern Sie Ihre API-Dokumentation, indem Sie Ihre API-Definition analysieren und Empfehlungen für Ihre Beschreibungen und Beispiele erstellen; siehe Verwendung des API-Assistenten zur Dokumentation Ihrer APIs.
Einschränkungen
Die Funktion API-Assistent unterliegt einer Ratenbegrenzung für Anrufe an den KI-Generator. Die beste Leistung erzielen Sie, wenn Sie den API-Assistenten für APIs von mittlerer Größe verwenden.
- Sie müssen einen " Premium subscription verwenden. Informationen zu den verschiedenen Abonnements und zum Upgrade finden Sie unter Kauf-, Abonnement- und Upgrade-Informationen.
- Sie müssen online im API Manager arbeiten (das lokale Arbeiten im API Designer wird nicht unterstützt).
- Ihre API-Definition muss der OpenAPI 3.0 Spezifikation entsprechen (OpenAPI 2.0 wird nicht unterstützt).