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 规范：
  • 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 将出现在后端服务器列表中。您可以选择 Sort by "Created At" 来查找您新创建的后端 API 并查看详细信息以确保一切正确：

提示

• 仔细检查 OpenAPI 规范的准确性。
• 使用清晰的名称和描述以便于识别。
• 确保身份验证类型与您的后端安全要求匹配。