OpenAPI Generatore

Modifica online

Lo strumento di generazione di OpenAPI genera documenti OpenAPI da zero sulla base delle indicazioni fornite dall'utente.

Lo strumento OpenAPI generator può essere utilizzato per generare documenti OpenAPI 3.0 in formato JSON o YAML partendo da zero, sulla base di richieste fornite dall'utente che utilizza l'elaborazione del linguaggio naturale (NLP). Data in input una descrizione in linguaggio naturale di un'API o di un'applicazione per la quale l'utente desidera generare un documento OpenAPI, lo strumento utilizza il modello Granite 3 disponibile su IBM watsonx per generare uno stub iniziale di un documento OpenAPI che l'utente può poi prendere e continuare a costruire.
Nota: lo strumento genera documenti in formato OpenAPI a partire da una descrizione in linguaggio naturale, mentre lo strumento di creazione OAS genera documenti in formato OpenAPI a partire da uno schema di database esistente aggiunto alle origini dell'API Agent.

Dettagli e limiti dello strumento

Di seguito sono riportati i dettagli e le limitazioni dello strumento Open API Generator:
  • Questo strumento è fornito per assistere gli utenti nel compito di generare un documento OpenAPI da zero sulla base di una descrizione in linguaggio naturale; non deve essere confuso con lo strumento OAS creator, anch'esso disponibile per API Agent, che viene utilizzato per generare un documento OpenAPI da uno schema di database esistente aggiunto alle sorgenti API Agent.
  • Questo strumento si basa sul modello di fondazione Granite 3 disponibile IBM watsonx per la generazione di documenti OpenAPI.
  • Poiché questo strumento si basa sull'output del modello di fondazione basato sulla descrizione degli input forniti, come tutti i modelli di intelligenza artificiale, l'output è soggetto a errori.
  • Se il documento OpenAPI generato non corrisponde alla descrizione fornita come input, provare di nuovo e considerare di riformulare la descrizione.
  • Se il documento generato in formato « OpenAPI » visualizzato dal modello contiene errori, quali errori di specificazione dell’« OpenAPI » o errori semantici, lo strumento sottopone automaticamente il documento all’operazione di correzione (correzione automatica) dello strumento « OpenAPI Enhancer ». Se dopo questa correzione sono ancora presenti errori, questi verranno segnalati nella finestra di chat.

  • Se il documento generato in formato OpenAPI contiene errori di sintassi JSON o YAML che non possono essere corretti (autocorretti) dallo strumento OpenAPI Enhancer, lo strumento non visualizza il documento. In questa situazione, il sistema visualizza il seguente messaggio: please re-phrase and try again. Provate a riformulare la descrizione dell'input prima di riprovare, ad esempio utilizzando un ordine o una combinazione di parole diversa nella richiesta di input.

  • Tutti i documenti OpenAPI generati da questo strumento devono essere esaminati per verificarne la correttezza e l'accuratezza prima di essere utilizzati.

Generare un documento OpenAPI da una descrizione in linguaggio naturale

È possibile generare un documento OpenAPI 3.0 da zero in formato JSON o YAML, a partire da una descrizione in linguaggio naturale fornita in inglese (una o più frasi) per l'API o l'applicazione che si desidera generare. È sufficiente iniziare la richiesta di chat con Generate an openapi for.... Il documento OpenAPI generato contiene gli schemi dei componenti rilevanti per l'API o l'applicazione descritta e gli elementi di percorso per le operazioni di creazione, recupero, aggiornamento e cancellazione di tali schemi. Inoltre, il documento generato include la sicurezza a livello di operazione e gli schemi di sicurezza raccomandati per impostazione predefinita, a meno che non venga richiesto esplicitamente di non farlo.

Nota: suddividete la richiesta in più frasi significative. È possibile indicare il tipo di API che si desidera generare nella prima frase e le specifiche richieste nelle frasi successive.

Questa operazione viene visualizzata con i seguenti dettagli: Il documento OpenAPI 3.0 generato in formato JSON o YAML (per impostazione predefinita, se il formato YAML non è specificato nel messaggio di richiesta di input) che può essere scaricato.

Tabella 1. Parametri
Parametro Obbligatorio Descrizione Predefinito
text Vero La descrizione in linguaggio naturale della specifica OpenAPI 3.0 da generare
Nota:

L'intero messaggio di richiesta di input viene utilizzato come valore del parametro di testo. Non è necessario fare riferimento esplicito ad esso.

 Nessuna
file_format N Lo strumento Open API Generator supporta il formato di output del file di documento OpenAPI generato in JSON e YAML. YAML
Esempi di prompt
Generate an OpenAPI spec for a weather application

Generate an OpenAPI spec for a book library application

Generate an openapi for a blog application in yaml format

Generate an OpenAPI spec for a blog application. Include operations for searching for blogs by most recommended topics. Searching for blogs should not require any authentication

Generate an OpenAPI spec for a weather application. Include an operation to provide a 7-day forecast for a given location

Genrate an OpenAPI spec for a book library application. Include operations to add and remove books from the library. Also include an operation to search the books in the library with a title

Azione successiva suggerita

  • Generare il codice del server fastapi per il file openapi {@filename}
  • Generare il codice del server fastapi con l'integrazione del database per il file openapi {@filename}