OpenAPI 発電機

OpenAPI ジェネレーター・ツールは、入力されたプロンプトに基づいて OpenAPI ドキュメントをゼロから生成します。

OpenAPI ジェネレーター・ツールは、自然言語処理（NLP）を使用するユーザーによって提供されるプロンプトに基づいて、JSON または YAML フォーマットの OpenAPI 3.0 ドキュメントをゼロから生成するために使用できます。 ユーザーが OpenAPI ドキュメントを生成したいAPIやアプリケーションの自然言語記述を入力として与えると、このツールは IBM watsonx で利用可能な Granite 3 モデルを使用して、 OpenAPI ドキュメントのスタータースタブを生成する。
注： このツールは自然言語の記述から OpenAPI ドキュメントを生成するが、 OAS 作成ツールは API Agent のソースに追加された既存のデータベーススキーマから OpenAPI ドキュメントを生成する。

ツールの詳細と制限

以下は、Open API Generatorツールの詳細と制限事項です：
  • このツールは、自然言語記述に基づいて OpenAPI ドキュメントをゼロから生成するタスクでユーザーを支援するために提供される。このツールは、 API エージェントソースに追加された既存のデータベーススキーマから OpenAPI ドキュメントを生成するために使用される、同じく API Agent で利用可能な OAS クリエイターツールと混同してはならない。
  • このツールは、 IBM watsonx OpenAPI ドキュメント生成のために利用可能な Granite 3基礎モデルに依存しています。
  • このツールは、提供された入力記述に基づく基礎モデルの出力に依存しているため、他のAIモデルと同様に、出力には誤差が生じる可能性がある。
  • 生成された OpenAPI ドキュメントが、入力として提供された説明と一致しない場合は、もう一度試して、説明を言い換えることを検討してください。
  • モデルから表示される生成された OpenAPI ドキュメントに、 OpenAPI 仕様エラーやセマンティックエラーなどのエラーが含まれている場合、このツールは自動的に OpenAPI Enhancer ツールの修正（自動修正）操作にドキュメントを通します。 この修正後もエラーが残っている場合は、チャットウィンドウで報告されます。

  • 生成された OpenAPI ドキュメントに、 OpenAPI Enhancer ツールで修正（自動修正）できない JSON または YAML 構文エラーが含まれている場合、ツールはドキュメントを表示しません。 この場合、システムは次のようなメッセージを表示する： please re-phrase and try again. 再試行する前に、入力プロンプトの順序や単語の組み合わせを変えてみるなど、入力説明を書き換えてみてください。

  • このツールによって生成されたすべての OpenAPI 文書は、使用する前に正確性と正確性を確認する必要があります。

自然言語記述から OpenAPI ドキュメントを生成する

生成したいAPIやアプリケーションについて、英語で与えられた自然言語の説明（1つまたは複数の文）から、JSONまたはYAML形式で OpenAPI 3.0 ドキュメントをゼロから生成することができます。 Generate an openapi for... でチャットプロンプトを開始してください。 生成された OpenAPI ドキュメントには、記述されている API またはアプリケーションに関連するコンポーネント・スキーマと、それらのスキーマに対する作成、取得、更新、および削除操作のパス項目が含まれています。 また、生成されたドキュメントには、明示的にそうしないように促されない限り、デフォルトで推奨される操作レベルのセキュリティとセキュリティスキーマが含まれる。

注： プロンプトを複数の意味のある文章として分割してください。 最初の文章で生成したいAPIの種類を、次の文章で必要な仕様を述べればよい。

この操作は以下の詳細を表示します：生成された OpenAPI 3.0 ドキュメント (JSON 形式または YAML 形式) (入力プロンプトメッセージで YAML 形式が指定されていない場合はデフォルト)。

表 1. パラメーター
パラメーター 必須 説明 デフォルト
text はい 生成される OpenAPI 3.0 仕様の自然言語記述
注:

入力プロンプトメッセージ全体がテキストパラメータ値として使用される。 明示的に参照する必要はない。

 なし
file_format いいえ Open API Generatorツールは、生成された OpenAPI ドキュメントファイルの出力形式として、JSONとYAMLをサポートしています。 YAML
プロンプトの例
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

次のアクションを提案

  • openapiファイル用のfastapiサーバーコードを生成する {@filename}
  • openapiファイルにデータベースを統合したfastapiサーバーコードを生成する。 {@filename}