Register a New Backend API

AI Agent Studio内で、OpenAPI仕様を登録してバックエンドを自動生成できます。

新しいバックエンドAPIを登録するには、Agent StudioダッシュボードのBackend Serversタブに移動し、以下の手順に従ってください。

1. ページの右上にあるRegister Backendボタンを見つけてクリックし、登録プロセスを開始します。

2. 登録フォームの以下のフィールドにバックエンドAPIの詳細を入力します：

• Domain: バックエンドサーバーのルートドメインまたはベースURLを入力します（例: https://petstore3.swagger.io）。
• BasePath: APIエンドポイントのベースパスを指定します（例: /api/v3）。
• Backend Name: このバックエンドのユニークな名前を選択します（例: PetstoreV3）。これにより、サーバーリストでバックエンドを識別できます。
• Version: APIバージョンを指定します（例: v1.0.0）。
• Open API Specification: API仕様を次の3つの方法のいずれかで提供できます：
  • From URL: OpenAPI/Swagger仕様へのリンクを貼り付けます（例: https://petstore3.swagger.io/openapi.json）
  • Paste JSON: OpenAPI仕様のJSONテキストを貼り付けます。
  • Upload File: Swagger/OpenAPIファイル（JSONまたはYAML）をアップロードします。
• Description: APIの目的と機能を説明する短い説明を書きます。
• Authentication Type: このバックエンドサーバーに必要な認証の種類を選択します：
  • Basic: 認証のためにユーザー名とパスワードが必要です。
  • Bearer: Authorizationヘッダーにベアラートークン（JWTなど）が必要です。
• API Key: 特定のAPIキーを送信する必要があります。通常、リクエストヘッダーまたはクエリパラメータに含まれます。
  • None: APIは公開されており、アクセスに認証情報は必要ありません。
• Label: フィルタリング目的のために必要なだけラベルを追加してください。ラベルは、画面のバックエンドサーバーリストの各カードに表示されます。

3. すべてのフィールドに入力し、情報が正しいことを確認したら、Saveボタンをクリックします。キャンセルしたい場合は、Cancelボタンをクリックしてください。

登録が成功裏に保存されると、新しいバックエンドAPIがバックエンドサーバーリストに表示されます。新しく作成したバックエンドAPIを見つけて、すべてが正しいことを確認するために、Sort by "Created At"を選択できます：

ヒント

• OpenAPI仕様の正確性を再確認してください。
• 簡潔な名前と説明を使用して、容易に識別できるようにしてください。
• 認証タイプがバックエンドのセキュリティ要件に一致していることを確認してください。