API Agent consente di generare codice Python da una specifica OpenAPI, distribuire il codice generato su IBM Code Engine e aggiornare il documento sorgente OpenAPI per riflettere l'applicazione Code Engine URL dopo la distribuzione.
Informazioni su questa attività
Utilizzare API Agent per generare il codice del server Python FastAPI basato sulle specifiche OpenAPI 3.0. Per ulteriori dettagli su come generare il codice server Python FastAPI, consultare lo strumento OpenAPI Python Generator.
I passi seguenti forniscono un esempio di flusso di scenario singolo su come creare codice server per un server CRUD di database.
Procedura
Per generare un codice Python, completare i seguenti passaggi:
- Accedere a API Agent. Per ulteriori informazioni, vedere Guida introduttiva.
- Immettere la seguente richiesta e fare clic su Invia :
Generate some Python FastAPI server with database interaction code based on the following openapi @
e selezionare il file desiderato, ad esempio
order_apispec.yaml.
Nota: Se si digita @ dopo la richiesta, viene visualizzato un elenco di documenti OpenAPI disponibili nell'area di lavoro.
- Fare clic su Invia. Lo strumento OpenAPI Python Generator comunica con le fonti API Agent e visualizza il piano proposto.
- Fare clic su Avvia per avviare la generazione del codice. Una volta completato, è possibile visualizzare un breve riepilogo dei passi successivi necessari per scaricare il codice generato e per eseguirlo e distribuirlo.
- Fare clic sull'icona di download per salvare il file ZIP contenente il codice.
- In Visual Studio Code, aprite il Terminale ed eseguite il seguente comando per estrarre il file scaricato in una cartella, ad esempio
app-code.
unzip PostgreSQL-order-python.zip
- Aprite il file
README.md per visualizzare le istruzioni su come iniziare a utilizzare il codice scaricato. Il sito README.md fornisce informazioni dettagliate su come costruire, installare, personalizzare e distribuire l'applicazione. - Inserite il seguente prompt per distribuire la cartella generata (assicuratevi che le vostre credenziali siano compilate):
zip -r code.zip app_code/
Nota: la dimensione del file deve essere inferiore a 1MB. Rimuovere la cartella venv/ prima di comprimere il codice e distribuirlo.
- L'azione successiva suggerita:
Deploy the application code from code.zip
Nota: se l'azione successiva prevista consiste nel distribuire l'applicazione server generata Python FastAPI su IBM Code Engine utilizzando lo strumento
di distribuzione del codice, assicurarsi che il documento di origine OpenAPI da cui è stata generata l'applicazione venga aggiornato dopo la distribuzione in modo da indicare l'applicazione Code Engine URL come valore di
servers[0].url. Questo passaggio è fondamentale se l'azione successiva prevista consiste nel creare una bozza di API e pubblicarla su API Connect utilizzando lo
strumento " API Connect ". Per ulteriori informazioni, consultare la sezione
Stato di distribuzione del codice.