OpenAPI Python 発電機

OpenAPI Python Generator toolは、 OpenAPI specification 3.0 specificationに基づいて、 Python FastAPI server codeを作成します。 このコードは、 OpenAPI ドキュメントで定義されている API エンドポイントを素早く足場にするのに役立ちます。これにより、定型的なコードを書く代わりにビジネスロジックの実装に集中することができます。

重要： 事前に OpenAPI ドキュメントを作成しておいてください。
ハイライト
  • Python FastAPI バックエンドサーバーを、入力 OpenAPI 3.0 仕様に基づいて生成する。
  • 3種類のサーバー生成に対応：
    • API レスポンスをモックするためのシンプルなサーバー。
    • データベースの作成、取得、更新、削除 データベースを直接操作するサーバー。
    • IBM コネクティビティパックアプリケーションと相互作用するためのコネクタパックサーバ。
OpenAPI Python Generator ツールでは、以下の操作がサポートされています：
表 1. パラメーター
パラメーター 必須 説明 デフォルト
input_file はい YAML または JSON 形式の OpenAPI 仕様書。 なし
server_type いいえ 生成したいサーバータイプ。 空白（単純なサーバータイプを示す）
database_type いいえ データベース CRUD タイプサーバーを生成する際に使用するデータベース言語タイプ Postgres

シンプルなサーバー

サービス構築を開始するための基本的なセットアップを提供する最小限のサーバーです。

プロンプトの例
Generate some Python FastAPI server code based on the following openapi @<filename.yaml>

データベースCRUDサーバー

作成、読み込み、更新、削除 (CRUD) 操作を実行するデータベースロジックを組み込んだ Simple Server の拡張です。 このタイプは、永続的なデータ管理を必要とするアプリケーションに適している。 デフォルトでは Postgres が使用されますが、 DynamoDB や Db2 を使用することもできます。

プロンプトの例
Generate some Python FastAPI server with database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with postgres database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with dynamodb database interaction code based on the following openapi @<filename.yaml>

Generate some Python FastAPI server with db2 database interaction code based on the following openapi @<filename.yaml>

コネクタパックサーバー

Connector Pack サーバーバリアントは、 IBM Connectivity Pack と統合するためのコードを生成するように設計されています。 OASCreator Tool を使って、このサーバーのタイプに合わせた OpenAPI 3.0 仕様を作成することから始めよう。 このコード生成により、コネクタ・アプリケーションの生成に必要な重要な情報を提供することができる。 その仕様から、ジェネレーターは、 FastAPI バックエンドと、 IBM Connectivity Pack エンドポイントとのすべての通信を処理する Client SDK ライブラリの両方を生成する。

以下の IBM コネクティビティパックアプリケーションに対応しています：
  • Postgres
  • DynamoDB
  • Db2
  • Salesforce
  • ServiceNow
プロンプトの例
Generate some Python FastAPI server for a connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a postgres connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a dynamodb connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a db2 connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a salesforce connector based on the following openapi @<filename.yaml>

Generate some Python FastAPI server for a servicenow connector based on the following openapi @<filename.yaml>
重要:
  1. IBM コネクティビティパック コネクタ URL は、生成された config.json に自動的に入力されます。 このルートはホワイトリスト化されたAPIを持ち、 IBM マネージド Code Engine インスタンスにデプロイされたアプリケーションにのみ呼び出しを許可します。 このルートに対してローカルAPIコールを行うことはできません。
  2. API Agent でサポートされるアプリケーションについては、提供される IBM コネクティビティパックルートに API コールを行うために、独自の認証情報を持参する必要があります。 これらの認証情報は、生成された config.json に入力されなければならない。 認証情報の設定はアプリケーションによって異なる。