Utilizzare l' Assistente API per migliorare le specifiche API

È possibile utilizzare l' Assistente API per analizzare le specifiche di OpenAPI 3.0 e generare raccomandazioni AI per correzioni di convalida e miglioramenti della documentazione. Migliorare le specifiche delle API accelera la loro adozione da parte dei consumatori.

Informazioni su

L' assistente API in IBM® API Connect Enterprise as a Service utilizza i modelli di IBM watsonx Granite LLM per aiutarvi a costruire le vostre API più velocemente. Sfruttate l' API Assistant per generare rapidamente correzioni AI per le vostre definizioni API e per suggerire descrizioni ed esempi utili per i vostri documenti API.

L' Assistente API è costituito dai seguenti due componenti:
Errori di convalida delle specifiche
Migliorare l'API analizzando la specifica OpenAPI 3.0 e generando potenziali correzioni dell'AI per qualsiasi errore di convalida; vedere Usare l'API Assistant per la correzione degli errori.
Miglioramenti alle specifiche
Migliorare la documentazione dell'API analizzando la definizione dell'API e generando raccomandazioni per le descrizioni e gli esempi; vedere Using the API Assistant to document your API.

Limitazioni

La funzione API Assistant è soggetta a un limite di velocità per le chiamate al generatore di intelligenza artificiale. Per ottenere le migliori prestazioni, utilizzare API Assistant su API di dimensioni moderate.

Inoltre, si applicano le seguenti limitazioni:
  • È necessario utilizzare un 'Premium subscription. Per informazioni sui diversi abbonamenti e sulle modalità di aggiornamento, vedere Informazioni su acquisto, abbonamento e aggiornamento.
  • È necessario lavorare online in API Manager (non è supportato il lavoro locale in API Designer).
  • La definizione dell'API deve essere conforme alla specifica OpenAPI 3.0 (OpenAPI 2.0 non è supportata).