API Agent hilft Ihnen, Python Code aus einer OpenAPI Spezifikation zu generieren, den generierten Code auf IBM Code Engine zu verteilen und das Quelldokument OpenAPI zu aktualisieren, um die Code Engine Anwendung URL nach der Verteilung wiederzugeben.
Informationen zu dieser Task
Verwenden Sie API Agent , um Python FastAPI Servercode zu generieren, der auf Ihrer OpenAPI Spezifikation 3.0 basiert. Weitere Informationen zur Erstellung des Server-Codes für „ Python “ ( FastAPI ) finden Sie unter „ OpenAPI “ ( Python Generator).
Die folgenden Schritte geben Ihnen ein Beispiel für die Erstellung von Servercode für einen Datenbank-CRUD-Server.
Vorgehensweise
Führen Sie die folgenden Schritte aus, um einen Python Code zu erstellen:
- Melden Sie sich bei API Agent an. Einzelheiten finden Sie unter Erste Schritte.
- Geben Sie die folgende Eingabeaufforderung ein, und klicken Sie auf Senden :
Generate some Python FastAPI server with database interaction code based on the following openapi @
und wählen Sie die gewünschte Datei aus, z. B.
order_apispec.yaml.
Hinweis: Wenn Sie nach der Aufforderung @ eingeben, wird eine Liste der in Ihrem Arbeitsbereich verfügbaren Dokumente OpenAPI angezeigt.
- Klicken Sie auf Senden. Das Werkzeug OpenAPI Python Generator kommuniziert mit den API-Agent-Quellen und zeigt den vorgeschlagenen Plan an.
- Klicken Sie auf Start, um mit der Codegenerierung zu beginnen. Nach Abschluss des Vorgangs erhalten Sie eine kurze Zusammenfassung der nächsten Schritte, die erforderlich sind, um den generierten Code herunterzuladen, und erfahren, wie Sie ihn ausführen und bereitstellen können.
- Klicken Sie auf das Download-Symbol, um die ZIP-Datei mit dem Code zu speichern.
- Öffnen Sie auf Visual Studio Code das Terminal und führen Sie den folgenden Befehl aus, um die heruntergeladene Datei in einen Ordner zu extrahieren, z. B.
app-code.
unzip PostgreSQL-order-python.zip
- Öffnen Sie die Datei
README.md , um die Anweisungen für die Verwendung des heruntergeladenen Codes zu sehen. Unter README.md finden Sie ausführliche Informationen zum Erstellen, Installieren, Anpassen und Bereitstellen der Anwendung. - Geben Sie die folgende Eingabeaufforderung ein, um den erstellten Ordner zu entpacken (stellen Sie sicher, dass Ihre Anmeldeinformationen ausgefüllt sind):
zip -r code.zip app_code/
Hinweis: Die Dateigröße muss kleiner als 1MB sein. Entfernen Sie den Ordner venv/ , bevor Sie Ihren Code komprimieren und bereitstellen.
- Die nächste vorgeschlagene Maßnahme:
Deploy the application code from code.zip
Hinweis: Wenn der nächste geplante Schritt darin besteht, die generierte PythonFastAPI Serveranwendung mithilfe des
Code-Bereitstellung Tools IBMCode Engine bereitzustellen, stellen Sie sicher, dass das OpenAPI Quelldokument, aus dem die Anwendung generiert wurde, nach der Bereitstellung aktualisiert wird, sodass die Code Engine Anwendung URL als Wert von
servers[0].urlangegeben wird. Dieser Schritt ist entscheidend, wenn als nächstes ein API-Entwurf erstellt und mithilfe des
Tools „ API Connect “ auf API Connect veröffentlicht werden soll. Weitere Informationen finden Sie im Abschnitt
Status der Codeeinführung.