API Agent OpenAPI 仕様から コードを生成し、生成されたコードを にデプロイし、デプロイ後に アプリケーション を反映するようにソース ドキュメントを更新するのに役立ちます。 Python IBM Code Engine Code Engine URL OpenAPI
このタスクについて
API Agent を使って、 Python FastAPI サーバー・コードを OpenAPI 仕様 3.0 に基づいて生成する。 Python FastAPI サーバーコードの生成方法の詳細については、 OpenAPI Python Generator ツールをご覧ください。
以下のステップでは、データベースCRUDサーバーのサーバーコードを作成する方法を、1つのシナリオフロー例として示します。
手順
Python コードを生成するには、以下の手順を実行する：
- ログイン API Agent. 詳しくは「 はじめに 」をご覧ください。
- 以下のプロンプトを入力し、[ 送信] をクリックする：
Generate some Python FastAPI server with database interaction code based on the following openapi @
をクリックし、必要なファイルを選択します。例えば、
order_apispec.yaml。
注： プロンプトの後に@を入力すると、ワークスペースで利用可能な OpenAPI 文書のリストが表示されます。
- 送信をクリックする。 OpenAPI Python Generatorツールは API Agentソースと通信し、提案されたプランを表示する。
- Startをクリックしてコード生成を開始する。 完了すると、生成されたコードをダウンロードするために必要な次のステップと、それを実行してデプロイする方法の簡単な要約を見ることができます。
- ダウンロードアイコンをクリックして、コードを含むZIPファイルを保存してください。
- Visual Studio Code で、ターミナルを開き、以下のコマンドを実行して、ダウンロードしたファイルをフォルダ、例えば
app-code に解凍する。
unzip PostgreSQL-order-python.zip
-
README.md ファイルを開いて、ダウンロードしたコードの使用方法をご覧ください。 README.md には、アプリケーションのビルド、インストール、カスタマイズ、デプロイ方法に関する詳細情報が記載されています。 - 以下のプロンプトを入力して、生成されたフォルダのzipを展開します（認証情報が入力されていることを確認してください）：
zip -r code.zip app_code/
注： ファイルサイズは 1MB 以下でなければなりません。 コードを圧縮してデプロイする前に、 venv/ フォルダーを削除してください。
- 次の行動が提案された：
Deploy the application code from code.zip
注： 次に、生成された Python FastAPI サーバーアプリケーションを、
Code Deployment ツールを使用して IBM Code Engine にデプロイする予定の場合は、デプロイ後に、アプリケーションの生成元となった OpenAPI ドキュメントを更新し、 Code Engine アプリケーション URL を の値として反映するように
servers[0].urlしてください。 この手順は、その後 「
API Connect 」タスクツールを使用してAPIのドラフトを作成し、 API Connect に公開する予定の場合、極めて重要です。 詳細については、
コード展開のステータスのセクションを参照してください。