OpenAPI互換REST API

OpenAPI互換REST APIとは何ですか。

OpenAPI (バージョン2.0または3.0、JSONまたはYAMLフォーマット)は、RESTful APIをドキュメント化するための業界標準です。次の機能が提供されます:

クリアなAPI定義: エンドポイント、HTTPメソッド、入出力パラメータ、認証メソッドおよび予期されるレスポンスがすべて正確に記述されます。
相互運用性: OpenAPIフォーマットで説明されているAPIは、プラットフォームおよびツール間で簡単に検出、使用および統合されます。

OpenAPI REST APIがエージェント構築プラットフォームで重要なのはなぜですか。

高速統合: MCPを介した直接統合が使用できない場合でも、OpenAPI仕様をアップロードして外部またはサードパーティのREST APIに即時に接続します。
再利用可能なエージェント・ツール: OpenAPI定義APIを、ナレッジまたはデータ分析エージェントが会話中に呼び出すことができるエージェント・ツールに変換します。
簡単なAPI管理: OpenAPI (v2.0/v3.0 JSON)をアップロードし、エンドポイントを確認してテストし、説明を更新し、パラメータの詳細を調整してエージェントとのやり取りをガイドします。
開発の高速化: APIのインポートと構成を自動化することで、手作業を削減し、エラーを防止し、エージェント機能の開発を高速化します。

REST APIのOAuth2の構成

REST APIデータ・ソースでは、OAuth2がサポートされます。REST APIを使用するための優先認証方法を追加します。

左側のサイドバーで「データ・ソース」を選択し、「データ・ソースの追加」ボタンを選択します。
「ソース・タイプ」として「Rest API」を選択し、オプションで「詳細構成」でデータ・ソースのカスタム名および説明を追加します。
OpenAPI 2.0以上の仕様のJSONファイルをアップロードして、APIエンドポイントを自動的に構成し、REST APIソースの追加ボタンを選択します。
「データ・ソース」ダッシュボードで「Rest API」タブを選択し、そのデータ・ソースの「アクション」列のロック・アイコンをクリックします。
「クライアントID」、「クライアント・シークレット」およびOAuth2フロー・タイプを入力して、このデータ・ソースへのREST APIアクセスを認可します。選択したフロー・タイプに基づいて、希望するスコープを選択できる新しいセレクタが表示されます。
認可のリクエストボタンを選択します。
'認可コード'フロー・タイプの場合、必要な権限を付与するページにリダイレクトされます。アクセスを承認すると、「認可は正常に完了しました。」と表示されるコールバック・ページに送信されます。その後、このタブを閉じてエージェント・ファクトリに戻ることができます。"認可に成功しました。これで、保護されたエンドポイントにアクセスできるようになりました。" というメッセージが表示された場合、認証設定が保存され、エージェント・ビルダーでREST APIの使用を開始できることを意味します。