プロンプト・ライブラリー

API Agent プロンプトライブラリでは、プロンプトを使用してさまざまなタスクを完了するための包括的なガイドを提供しています。

プロンプトを使用する際のガイドライン

正確で効率的な結果を得るには、プロンプトを入力する際に以下のガイドラインを使用してください：
  1. 皮肉やユーモアを伝える言葉や口調は誤解される可能性があるので避ける。
  2. 能動態を使い、文法やスペルを正しくし、明確で具体的な依頼を心がけましょう。
  3. 明確な文脈と関連キーワードを提供し、曖昧な用語やドメイン固有の用語は避ける。 例えば、 generate test または build API などです。
  4. システムがあなたの要求を理解できない場合は、要求に対する提案を行う。

前提条件

API Agent プラグインを使用すると、 API Connect に関連するタスクを実行できます。

  • API Agent にログインしていることを確認してください。 ログインおよび操作方法については、「 はじめに 」を参照してください。
  • API Agent を使用するには有効な権限が必要です。 詳細については、 API Agentのユーザーロールを参照してください。
  • API Connectの API Manager インタフェースを通じて、同じパーミッションを持っていることを確認してください。 API Agent プラグインを使用する権限があっても、 API Manager UI から同じタスクを完了するのに必要な権限がない場合、アクションは失敗します。

ケースに応じたプロンプトの使い方

次の表は、さまざまなアクションに対するプロンプトとその使用法を説明したものです。
表 1. プロンプトの使い方
アクション プロンプト 説明
テストケースの生成

APIのテストケースを生成する

Generate test cases for <pulbished api name>
  • テストケースを作成する前に、APIが公開されていることを確認してください。 詳細については、 ドラフトAPIの作成と公開を参照してください。
  • API Agent テスト・モジュールのスマート生成機能に接続し、利用可能な API ファイルの最初の 15 個のエンドポイントについてテスト・ケースを繰り返し作成します。 テストケースはテストスイートに格納され、 api name (AA_Test_Suite_<api_name>) とともにAA_Test_Suite が付加されます。
  • 生成が完了すると、 API Agent は、作成されたテストケースの数と、それらが作成されたテスト スイートの名前を示すステータス メッセージを表示します。
  • 生成されたテストケースは、 API Manager コンソールの Test モジュールで確認できます。
テストケースの実行

APIのテストケースを実行する

Run test cases for <pulbished api name>
注： <published api name> にはAPI名を記述すること。 バージョン情報を結合しないでください。 例えば、petstore などです。
  • Visual Studio Code で、公開 API のテストケースを実行できます。これには、テストの開始、結果の表示、テストケースの削除（オプション）が含まれます。

  • API Agent テスト・モジュールの Smart Generation 機能により、テストを実行するための入力パラメータのデータが生成されます。 API Agent は、実行が正常に開始されると、ステータスメッセージとテスト結果の URL を Visual Studio Code に表示します。

    ハイパーリンクをクリックすると、 API Manager コンソールで個々のテストケースの結果が表示されます。
テストケースの削除 
delete test case <test_name> in suite <suite_name>
テストスイートのリスト 
List test suites
 テストスーツのリストアップに使用できる。 また、スイート名をプロンプトに入力して、テストスイートを削除することもできます。
テストスイートの削除 
delete test suite <suite_name>
テストケースのリストアップ 
List test cases for test suite <test suite name>
  • テスト・スイートに対応するテスト・ケースを一覧表示するために使用できます。
  • テストスイートが利用可能であることを確認してください。 利用できない場合は、 テストケースの生成の行に記載されている手順に従います。
  • 利用可能なテスト・スイートを確認するには、 テスト・スイートの一覧の行を参照してください。
を作る OpenAPI
  • 受注テーブルのAPI仕様を作成するには
    create openapi for orders table
    または
    generate api spec for orders table
    注意： データベースは、他のスキーマに同じ名前のテーブルを含んではならない。
  • 受注テーブルのAPI仕様を作成するには
    create openapi for orders table with schema_name as purchase_order
    それとも
    create openapi for orders table in purchase_order schema
  • スキーマ名を使用せず、オブジェクト名を使用して受注テーブルのAPI仕様を作成するには
    create openapi for orders table with object_name as purchase_order_orders
  • ソース ID を使用して受注テーブルの API 仕様を作成するには
    create openapi for orders table with source_id as
    6c115670-a7e1-11ef-b576-fa5e88d5392d
  • OpenAPI、テーブル名の仕様を抽出し、コード・ジェネレーター固有のフォーマットに変換する
    Extract the openapi spec for the given table name and transforms to Code generator specific format
 以下は、Open API を作成するために使用できるプロンプトの例です
コードの生成
  • 単純なサーバータイプのコードを生成するには
    Generate some Python FastAPI server code based on the following openapi @my_file.yaml
    それとも
    Please build FastAPI backend code using the OpenAPI file @api_spec.yaml
    それとも
    Can you develop a Python FastAPI server using the openapi specification provided in @service_definition.json
  • データベースの作成、取得、更新、および削除サーバー・タイプのコードを生成するには
    Generate some Python FastAPI server code based on the following openapi @my_file.yaml that handles database operations
    それとも
    Can you develop a database driven Python FastAPI server using the openapi specification provided in @service_definition.json
    注: OpenAPI Python ジェネレータツールを使用したプロンプトの使用方法については、 OpenAPI Python ジェネレータツールを参照してください。
  
[技術プレビュー】 MCPサーバー
  • 有効なサーバーのリストを表示するには
    List me all the MCP servers that are currently enabled
    それとも
    List all available MCP servers
  • MCPサーバーの詳細を取得するには
    Fetch the details of GitHub™ MCP server
  • MCPサーバーを更新するには
    Update the enabled MCP server gitlab™ with updated deployed url [Add URL]
  • からMCPサーバーを無効にするには GitHub
    Remove the github™ MCP server from the enabled tools
  • 特定のMCPサーバーの詳細情報を取得するには
    Fetch details of the mcp server postman™
    または
    Show me the configuration details for the github™ MCP server
    それとも
    Get information about the weather MCP server
  • MCPサーバーが存在するかどうかを確認するには
    Check the existence of mcp server Github™
    それとも
    check availability of mcp server postman™
    それとも
    check if postman™ mcp server is available
 以下のプロンプトを使用して、MCPサーバーで以下の操作を行います：
  • 有効なサーバーのリスト
  • サーバーの詳細
  • 更新日
  • 無効化
  • 特定のMCPサーバーの詳細
  • MCPサーバーの存在確認

順次プロンプト

API Agent 、複数のツールを1つのプロンプトに連結し、次々に実行することができる。 以下はシーケンシャルプロンプトの例である：
  1. テストケースを作成して実行する
    create test cases for the petstore api and run the test cases

  2. ドラフトまたは公開されたAPIや製品をリストアップする
    list draft apis, draft products, published apis and published products
    それとも
    list published apis

  3. ドラフトAPIを作成し、 FastAPI サーバーコードを生成するには
    create draft api from file @openapi.yaml and generate fastapi server code from the same api file
    それとも
    create draft api using @file_name
  4. APIのセキュリティを確認する
    review security of api API_NAME:VERSION
  5. セキュリティを確認し、APIを検証する
    review security of api API_NAME:VERSION
    それとも
    validate api API_NAME:VERSION