エラー修正に APIアシスタントを使用する

API Assistantの仕様検証エラーコンポーネントを使用して、 OpenAPI 3.0 仕様を分析し、検証エラーのAI修正候補を生成することができます。 これにより、APIの配信をスピードアップし、検証エラーを減らすことができます。

APIアシスタントは、 IBM watsonx Granite LLM models 、APIの品質を向上させ、消費者により早くAPIを提供できるよう支援します。 APIアシスタントを活用して、API定義のAI修正を素早く生成できます。

API Assistant を使用して、 OpenAPI 3.0 検証エラーの AI 修正を生成する方法

API Manager で API 定義を作成または編集する場合は、 API Assistant を使用します。 APIアシスタントは、あなたのAPIを OpenAPI 3.0 仕様で検証し、検証エラーのAI修正を提案します。 その後、API定義に適用したい修正を選択できる。

  1. ログイン IBM® API Connect Enterprise as a Service 使用して Premium subscription。
  2. API Managerで、編集したいOpenAPI 3.0APIを開きます。
  3. デザインタブで、ソースビューアイコン（2つの角括弧で囲まれた小さなグレーの正方形で、スラッシュを囲んでいる）をクリックしてソースビューで作業する。
  4. AIアイコン（小さなグレーの正方形で、黒字でAIと矢印が書かれている） をクリックして、 API Assistant パネルを開きます。
  5. 仕様の検証エラータブ仕様の検証エラーのタブアイコン（小さなチェックマークが付いたページのアウトライン）が選択されていることを確認してください。
  6. 検証をクリックすると、OpenAPI検証仕様でAPIを実行します。
  7. APIで検証エラーが検出され、 APIアシスタントで修正できる場合は、修正案が表示されます。
    注意: すべての検証エラーや警告に、AI による修正が適用されるわけではありません。 たとえば、x-ibmに関連する問題のAI修正は返されません。
  8. 各提案に対して、修正をクリックすると、その修正をAPIに組み込むことができ、無視をクリックすると、その修正を無視することができます。

    すべての提案を素早く受け入れるには、修正を適用をクリックします。

  9. Saveをクリックして、更新されたAPI定義を保存します。

例サンプルの拡張 テスト エラー API

この例では、Test error API を使用して、API を OpenAPI 仕様で検証し、提案された AI の修正を確認し、それらの修正を適用するまでのフローを示します。 あなた自身のAPIを使って、この手順を実行することができる。

  1. API Connect Enterprise as a Service にログインするには、 Premium subscription。

  2. API Manager で、現像アイコン(白い鉛筆の輪郭を含む小さな黒い四角) Develop をクリックしてAPI開発ページを開き、API タブが選択されていることを確認して、APIを表示できるようにします。
    開発ページを開く

  3. Type OpenAPI 3.0 (REST)のAPIを選択し、タイトルをクリックして編集します。
    OpenAPI 3.0 API を編集します

  4. デザインページはフォームビューで開きます。 ソースビューで作業するには、ソースビューアイコン（2つの角括弧で囲まれた小さなグレーの正方形で、スラッシュを囲んでいる）をクリックします。

    API Assistantは、APIのソースコードを見ることができれば、より使いやすくなります。

    フォームビューのAPIデザインページのスクリーンショット。ソースビューのアイコンの周りがハイライトされている。

  5. AIアイコン（小さなグレーの正方形で、黒字でAIと矢印が書かれている） をクリックして、 API Assistant パネルを開きます。 仕様検証エラー タブが選択されていることを確認してください。
    仕様検証エラー・タブを開いた状態のAPIアシスタント・パネルを示すスクリーン・ショット。

  6. 仕様の検証エラー 」タブで、 AIが説明するアイコン（小さな黒い四角の輪郭で、AIという文字が含まれている） をクリックすると、 API Assistant が AI を使用して OpenAPI の構文エラーをすばやく解決する方法について詳しく知ることができます。
    AI仕様検証の説明ポップアップを示すスクリーンショット。

    ポップアップを閉じるには、もう一度AIが説明するアイコン（小さな黒い四角の輪郭で、AIという文字が含まれている）をクリックします。

  7. ここで Validate をクリックして、OpenAPI 3.0 仕様で API を検証し、AIの修正が特定されるかどうかを確認します。

    エラーが見つかり、それがAIによって修正可能な場合、 APIアシスタントは修正案のリストを返す。

    仕様の検証エラーに対するAIの推奨事項のスクリーンショット。

    次のような表示の変化に注目してください：

    • 仕様検証エラー ］タブには、 API Assistant が検出した仕様エラーのリストが表示されます。 発見されたエラーの総数がパネルの最初に表示される。
    • APIアシスタント・ パネルが開いている間、APIソース・コードは読み取り専用モードになっているため、誤って更新されることはありません。 パネルを閉じると、コードは再び編集可能になる。
    • エラーに対して AI による修正案が利用可能な場合、仕様検証エラータブに、無視および 修正オプションとともに修正案が表示されます。 修正案はソースコードにも表示され、元のエラーの直下にある。
    • AIによる修正がない場合、エラーは検証エラーアイコン検証エラーのアイコンは、白いバックスラッシュを含む小さな赤い点ですで表示されます。
  8. 提案された修正を受け入れるか拒否するかの準備ができたら、以下のオプションが利用できます：
    • 提案されたすべての修正を素早く受け入れるには、修正を適用をクリックします。
    • 個々の修正を受け入れるか拒否するかは、各提案で修正または無視をクリックしてください。
    • バリデーションを再度実行するには、すべてのアイコンを再生成するをクリックして、最新の仕様エラーとAIの修正をご覧ください。

    提案された修正を通して作業する際、以下の動作に注意してください：

    • 適用した修正はすべてAPI定義に追加されますが、APIページのヘッダーにある保存をクリックするまで、定義自体は保存されません。
    • 保存する前に、APIの編集を続け、再度検証を実行して修正案を再生成することができます。
    • 保存をクリックすると、あなた自身の変更と適用されたすべての修正が保存されます。
    • 修正を適用する前に API Design ページから移動すると、その修正は失われます。
  9. API Assistant パネルを閉じるには、 APIアシスタントパネルを閉じるアイコン をクリックします。

  10. フォームビューに戻りたい場合は、フォームビューアイコンをクリックします。

    サンプルAPIでは、提案されたAIの修正が適用され、仕様ステータスが緑色になっていることがわかります。

    すべてのエラーが修正されたサンプルAPIのスクリーンショット。

  11. 更新したAPI定義を保存するには、忘れずに保存をクリックしてください。